Credential Endpoints
Credential Endpoints and Parameters
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.
Note
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.
Note
If you are not a Curator, then results are limited to Credentials that you have access to and view, userId, and userGroupId parameters will be disregarded.
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.
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.