Credential Endpoints
Credential Endpoints and Parameters
- Retrieve All Credential Records
- Retrieve a Credential Record
- Share a Credential with a User
- Share a Credential with a User Group
- Remove a User from a Credential
- Remove a User Group from a Credential
- Delete a Credential
To learn more about the objects relations and how to use them in the API, go to the Object Relations section.
For more information about credentials, visit the Credentials help page.
We don’t permit credentials to be created through the API. To create a credential as an admin, use the Server UI.
Retrieve All Credential Records
To get information about all credentials, use the GET {baseURL}/v3/credentials endpoint.
Parameters
- view (string): Optional. Can be left without a value. You can choose from the following values: ‘Default’ and ‘Full’. If this parameter is set to 'Default’, then a reduced view object will be returned. When not specified, the ‘Default’ value is used.
- userId (string): Optional. To filter results by userId, enter the ID of a user.
- userGroupId (string): Optional. To filter results by userGroupId, enter the ID of a user group.
Retrieve a Credential Record
To retrieve information about a credential, use the GET {baseURL}/v3/credentials/{credentialId} endpoint.
Parameters
- credentialId (string): Required. Enter a collection ID to get the information about a specific credential.
Share a Credential with a User
To share a credential with a user, use the POST {baseURL}/v3/credentials/{credentialId}/users endpoint.
Parameters
- credentialId (string): Required. Enter a collection ID you want to share.
- contract (body): Required. Specify the following to share a credential with a user:
- userId (string): Required. Specify the ID of a user you want to share a credential with.
Share a Credential with a User Group
To share a credential with a user group, use the POST {baseURL}/v3/credentials/{credentialId}/userGroups endpoint.
Parameters
- credentialId (string): Required. Enter a credential ID you want to share.
- contract (body): Required. Specify the following to share a credential with a user group:
- userGroupId (string): Required. Specify the ID of a user group you want to share a credential with.
Remove a User from a Credential
To remove a user from a credential, use the DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId} endpoint.
Parameters
- credentialId (string): Required. Enter the credential ID from which you want to remove the user.
- userId (string): Required. Enter a user ID you want to remove from the credential.
Remove a User Group from a Credential
To remove a user group from a credential, use the DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId} endpoint.
Parameters
- credentialId (string): Required. Enter the credential ID from which you want to remove the user group.
- userGroupId (string): Required. Enter a user group ID you want to remove from the credential.
Delete a Credential
To remove a credential, use the DELETE {baseURL}/v3/credentials/{credentialId} endpoint.
Parameters
- credentialId (string): Required. Enter the credential ID you want to delete.
- force (boolean): Optional. Select whether you want to force the deletion of a credential in case there are any shares. If you want the credential deleted and all shares cleaned up, set the force parameter to true. When not selected, the default value is false. This is in order to protect against an errant call.
Objects Relations
To get information about existing credential IDs, use the GET /v3/credentials endpoint. The credentialId you get can be used when:
- You want to get information about a specific credential.
- You want to share a credential with a user.
- You want to share a credential with a user group.
- You want to remove a user from a credential.
- You want to remove a user group from a credential.
- You want to delete a specific credential.