Recipes

xxxxxxxxxx

hostname="https://se-demos-gstemp.us-dev.janraincapture.com"

​

curl -L -X POST "$hostname/entity.find" \

-H 'Authorization: Basic eTR4Zmc2ZjQ0bXNhYzN2ZXBqanZ4Z2d6dnQzZTNzazk6OTVjY3hrN2N6YnZ1eng2ZHB0ZTVrOXA2ZGo1Ynpla3U=' \

-H 'Content-Type: application/x-www-form-urlencoded' \

--data-urlencode 'type_name=user' \

--data-urlencode 'filter=primaryAddress.company='\''Akamai'\'' and primaryAddress.country='\''US'\''' \

--data-urlencode 'attributes=["givenName","familyName","primaryAddress.city","primaryAddress.stateAbbreviation"]' \

--data-urlencode 'sort_on=["familyName","givenName"]' \

• Search for user profiles

  Searches an entity type for users meeting the specified criteria. For example, you might search for all the users who haven’t logged on since a specified date, or for all the users who live in the United States.

  9 steps

  Open Recipe

• Get a user profile

  Returns the specified user profile. Note that Identity Cloud often refers to user profiles and user accounts as entities.

  9 steps

  Open Recipe

• Create a user profile

  Creates a user profile. Note that, because of database replication requirements, it might take a few minutes for the new user profile to be available to other operations.

  7 steps

  Open Recipe

• Invalidate user access grants

  Removes all existing access grants issued to the user, including access tokens, refresh tokens, and refresh secrets.

  8 steps

  Open Recipe

• Create an entity type

  Creates an entity type. Entity types are databases typically used for storing user profiles.

  7 steps

  Open Recipe

• Create an entity type attribute

  Creates an attribute and adds that attribute to an entity type. This also adds the new attribute to all existing user profiles.

  9 steps

  Open Recipe

• Create a validation rule

  Creates a data validation rule for specified attributes in your schema. Validation rules help ensure that the correct type of data is written to an attribute. For example, a validation rule might ensure that only a date value is written to the birthday attribute.

  9 steps

  Open Recipe

• Assign constraints to an attribute

  Configures the list of constraints for an attribute. Constraints place restrictions on the type of data that can be stored in an attribute.

  8 steps

  Open Recipe

• Modify password history settings

  Manages the password history settings for an entity type. Password history tracks the previous passwords employed by a user, and prevents the user from resetting their password to one of those prior values.

  8 steps

  Open Recipe

• Add an object attribute to an entity type

  Adds a new object attribute (testObject) to the user entity type. The new object contains two child attributes, testOne and testTwo, both 256 character string attributes. If this operation succeeds, testObject is automatically added to every user profile in the user entity type.

  7 steps

  Open Recipe

• Delete a plural entry

  WARNING. Be careful when using a command similar to the following. If you don’t get the attribute_name value exactly right the operation ignores the plural and deletes the entire user profile instead.

  Deletes a plural entry from the user profile with the UUID 30dd1406-f59a-4145-a6de-b94b5e8cacf3. In this example, the entry 30721 is removed from the plural janrain.properties.managedBy.

  7 steps

  Open Recipe

• Replace the values in a plural attribute

  Replaces the statuses plural in a user profile. Note that even though this API call uses the /entity.replace operation no other attribute values are changed or deleted. In this example, the value of the statuses plural is set to an empty array ([]).

  9 steps

  Open Recipe

• Update a plural attribute

  Updates the statuses plural (plural ID 5253) for the user with the id 121989. In this example, the status attribute is set to active.

  9 steps

  Open Recipe

• Find users who don't live in the US

  Searches an entity type for all the users who have set their primaryAddress.country attribute to a value other than US. Note that the response to this operation doesn't include users whose primaryAddress.country attribute is set to a null value. To include those users, use this filter: primaryAddress.country != 'US' OR primaryAddress.country is null.

  8 steps

  Open Recipe

• Find users who have supplied their date of birth

  Searches an entity type for all the users who have included their date of birth in their user profile (that is, their birthday attribute is set to a non-null value).

  8 steps

  Open Recipe

• Verify a user's password

  Verifies the password assigned to the user with the ID 101860. To do this, the operation specifies the attribute to be checked (password) and the supplied password value (p@ssw0rd). If the supplied value matches the user’s actual password (i.e., if the password is verified), the values in the attributes parameter are returned in the operation response.

  10 steps

  Open Recipe

• Add a plural attribute to an entity type

  Creates a new plural attribute named **testPlural" and adds that attribute to an entity type. The new plural contains two 256-character child attributes, testPluralOne and testPluralTwo.

  7 steps

  Open Recipe