Capture API: /entityJanrain Developers

/entity

Retrieve a single entity (and any nested objects).

The entity call may also use two optional parameters to validate a password. See the Validating User Passwords topic for more information.

Parameter	Required	Description

To authenticate this call, you may use either the client credentials found in the dashboard (`client_secret`, and `client_id` parameters), or you can use the OAuth authentication method which exchanges client credentials for an `access_token`. For a complete explanation, please refer to the OAuth Authentication topic.
`client_secret` `string`		Required when authenticating with client settings. The shared secret paired with the `client_id`, which you can find in the dashboard. Do not use when authenticating with the `access_token` parameter.
`client_id` `string`		Required when authenticating with client settings. You can find the client identifier in the dashboard. Do not use when authenticating with the `access_token` parameter.
`access_token` `string`		Required when authenticating with an OAuth `access_token`. Do not use when using `client_id` and `client_secret`.

This API call requires a record selector to target a single entity. To select a record, use one of either `uuid` or `id`, or use both of `key_attribute` and `key_value`. Refer to the Selecting Entities topic for more information.
`uuid` `string`		Required when not using `id` or `key_attribute` paramaters. The unique identifier given the user entity.
`id` `string`		Required when not using `key_attribute` or `uuid` parameters. The primary key of the parent object.
`key_attribute` `string`		Required when not using `id` or `uuid`. This value is any attribute in the schema with a `unique` constraint.
`key_value` `string`		Required when using `key_attribute`. This is the value of the unique attribute. Note: String values need to be enclosed in quotes.

Use the optional `password_attribute` and `password_value` parameters together. Use the attribute parameter to specify the attribute to modify, and the value parameter to specify the new value for that attribute.
`password_attribute` `string`		Entity can be used to validate user passwords. The value is the path to an attribute with a password constraint in the schema.
`password_value` `string`		A plaintext value that will be matched against the password attribute specified in the `password_attribute` parameter. If successful, the entity will be returned. If unsuccessful, an error code will be returned.

`type_name` `string`	Yes	The `entityType` of the `entity`.
`attribute_name` `string`	No	This is a schema path to an individual attribute. Will return only the attribute value, instead of the entire record.
`attributes` `string`	No	This is a JSON array of attributes. This works the same as `attribute_name`, only returning the specified attributes instead of the entire record.
`created` `string`	No	Timestamps are generated when an entity is created. This value may be used to help identify the entity in this parameter. If a value is present in this parameter, and is incorrect, the call will fail. To format this parameter, see the Timestamp section in the Attributes topic.
`last_updated` `string`	No	Timestamps are generated when an entity is updated. This value may be used to help identify the entity in this parameter. If a value is present in this parameter, and is incorrect, the call will fail. To format this parameter, see the Timestamp section in the Attributes topic.

https://yourdomain.com/entity?type_name=user&id=1&client_id=12345678912345678912345678912345&client_secret=98765432198765432198765432198765

Retrieve an entity of entityType user by id.

{"result":
  {"id":"1",
   "firstName":"Robert"
  },
 "stat": "ok"
}

Note: This API call requires a Capture Express service level.