latestOpenAPI 3.0.32026-08-109359194.9 KB

112399a67ebb

Credentials

Get credentials

Get credentials.

Authorization Required:

  • Designer Administrator
get/credentials

Query parameters

limitinteger

Integer to limit the number of applications returned (Cannot exceed 1000)

sortstring

Field to sort found applications by

offsetinteger

Offset for paginated results

sortOrderinteger

Sort order for found applications (1 = ascending, -1 = descending)

filterstring

Filter conditions for searching users, formatted like ?filter=name=Bill. The filters should be ; separated, as shown below. Supported fields are "credentialType", "name". All filter conditions are "starts with". NOTE: When filtering on created and modified, all timestamps are in UTC. You need to encode reserved url characters if they are part of the data you are filtering. Example, * ' ( ) : @ & = + $ , / ? % # [ ] You need to double encode ; as %253B if it is a part of the data you are filtering.

Examples:

  • filter=email=john@doe.com will fetch all users starting with email "john@doe.com"
  • filter=role=Admin;created>2019-06-11T21:50:57.067Z will fetch all user with role starting with "Admin" and created after "2019-06-11T21:50:57.067Z" (UTC)
  • filter=modified=2019-06-11T21:50:57.067Z will fetch users modified at exactly "2019-06-11T21:50:57.067Z" (UTC)
  • filter=created>2019-06-11T00:00:00.000Z;created<2019-06-20T00:00:00.000Z will fetch users created between "2019-06-11T00:00:00.000Z" (UTC) and "2019-06-20T00:00:00.000Z" (UTC)

Supported operators (as specified in this library api-query-params):

  • key=val type=public
  • key>val count>5
  • key>=val rating>=9.5
  • key<val createdAt<2016-01-01
  • key<=val score<=-5
  • key!=val status!=success
  • key=val1,val2 country=GB,US
  • key!=val1,val2 lang!=fr,en
  • key phone
  • !key !email
  • key=/value/<opts> email=/@gmail\.com$/i
  • key!=/value/<opts> phone!=/^06/

Note: multiple forward slashes (/) are interpreted as a regex. To use a string comparison wrap your parameter with string(). Ex. email=string(/@gmail.com$/i).

Response

Array containing JSON objects of each found credential

clientIdstring required

Client ID of the credential.

namestring required

Name of the credential.

rolestring required

Express role of the credential.

rolesstring[] required

Creator or Express roles of the credential.

groupsstring[]

Express groups of the credential.

applicationRolesobject

Application Express roles of the credential.

createdstring required

Date of when the credential was created.

modifiedstring

Date of when the credential was modified.

statusstring required

Status of the credential.

credentialTypestring required

Type of the credential (Creator or Express).

expireDatestring

Date of when the credential expires.