Identity APIs
The Identity interface manages users and group access. The Web SDK supports the following identity providers for viewing individuals and groups of users:
| Provider | Requirements |
|---|---|
| AD | Read only. Allows view capability from an external Microsoft Active Directory (AD). Requires an Active Directory connection before making API calls. For more information, see the Administration Guide. |
| LDAP | Read only. Allows view capability from an external Lightweight Directory Access Protocol (LDAP) data source. Requires setup before making API calls. Use the LDAP Identity Provider Wizard. For more information, see the Administration Guide. |
| Local | Default. Allows view capability and password rotation only in Trust Protection Platform. |
What is the difference between Credentials, Permissions, and Identity?
- Credentials endpoints manage certificate and other activities. For more information, see Credentials APIs.
- Identity endpoints manage Venafi users. For more information, see Identity APIs.
- Permissions endpoints grant principals (users and groups) privileges to objects within Trust Protection Platform. For more information, see Permission API.
📄️ Search Identity Entries
Returns information about individual identity, group identity, or distribution groups from a local or non-local
📄️ Get Associated Identity Entries
Returns all associated identity groups and folders for a given identity entry.
📄️ Get Group Members
Returns information about the members of an identity group. Members include owners. If you want group information about just one user, call POST Identity/GetMemberships.
📄️ Get Groups
Returns information about a user's membership in an identity provider.
📄️ Read Attribute
Returns an array of attributes for the requested person or group's identity. The caller is not required to have any special permissions.
📄️ Verify Identity Entry
Validates and returns missing information about an identity.
📄️ Who Am I
Returns the Web SDK caller's self identity and all identities associated with the authenticated identity.
📄️ Change Password
Rotates a password for an identity. Password rotation for a group account is not supported. Password rotation
📄️ Add Group
Adds a group to an identity provider. The group or team resides in the local provider.
📄️ Rename Group
Renames a group in an identity provider.
📄️ Delete Group
Deletes a group from an identity provider. The local group or team can contain users
📄️ Add Group Members
Assigns members to a group in an identity provider. The group resides in the local provider. However, members,
📄️ Remove Group Members
Removes a member from a group in an identity provider. Even though the user or group is removed from the local group, Trust Protection Platform retains the identities.