API endpoints
Every route of the Pocket ID REST API on one page, grouped by resource, with its parameters, request body and response fields.
Every route of the REST API, with the parameters it takes and the fields it answers with. The page comes from the backend's spec at every docs build, so it lists what the code serves.
Send an API key in the X-API-KEY header with each call. REST API covers creating keys and the shape of errors. The raw OpenAPI spec is available as openapi.json for Postman, code generators and AI assistants.
Users, their passkeys and profile pictures, login codes and signup tokens.
- post
/api/one-time-access-emailRequest one-time access email - post
/api/one-time-access-tokenExchange one-time access token - post
/api/signupSign up - get
/api/signup-tokensList signup tokens - post
/api/signup-tokensCreate signup token - delete
/api/signup-tokens/{id}Delete signup token - get
/api/signup/setupCheck initial admin setup - post
/api/signup/setupSign up initial admin user - get
/api/usersList users - post
/api/usersCreate user - get
/api/users/meGet current user - put
/api/users/meUpdate current user - patch
/api/users/meUpdate current user - get
/api/users/me/email-changeGet pending email change - delete
/api/users/me/email-changeCancel pending email change - put
/api/users/me/profile-pictureUpdate current user's profile picture - delete
/api/users/me/profile-pictureReset current user's profile picture - post
/api/users/me/send-email-verificationSend email verification - post
/api/users/me/verify-emailVerify email - get
/api/users/{id}Get user by ID - put
/api/users/{id}Update user - patch
/api/users/{id}Update user - delete
/api/users/{id}Delete user - get
/api/users/{id}/groupsGet user groups - post
/api/users/{id}/one-time-access-emailRequest one-time access email (admin) - post
/api/users/{id}/one-time-access-tokenCreate one-time access token for user (admin) - put
/api/users/{id}/profile-pictureUpdate user profile picture - delete
/api/users/{id}/profile-pictureReset user profile picture - get
/api/users/{id}/profile-picture.pngGet user profile picture - put
/api/users/{id}/user-groupsUpdate user groups - get
/api/users/{id}/webauthn-credentialsList user passkeys - delete
/api/users/{id}/webauthn-credentials/{credentialId}Delete user passkey
Request one-time access email
Section titled “Request one-time access email”/api/one-time-access-emailRequest a one-time access email for unauthenticated users
Body application/json
emailstringrequiredredirectPathstring
Response
Exchange one-time access token
Section titled “Exchange one-time access token”/api/one-time-access-tokenExchange a one-time access token for a session token
Query parameters
rememberbooleanSet to false for a session that ends when the browser closes or after 20 minutes without activity
defaults to
true
Body application/json
tokenstring
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Sign up
Section titled “Sign up”/api/signupCreate a new user account
Body application/json
usernamestringrequired1 to 50 characters
emailstring or nullfirstNamestringat most 50 characters
lastNamestringat most 50 characters
tokenstring
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
List signup tokens
Section titled “List signup tokens”/api/signup-tokensGet a paginated list of signup tokens
Query parameters
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
createdAt,expiresAt,usageCount,usageLimitsort[direction]stringSort direction
One of
asc,desc· defaults toasc
Response
2 fields
dataarray of objects or null7 fields per item
createdAtdate-time stringexpiresAtdate-time stringidstringtokenstringusageCountintegerusageLimitintegeruserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Create signup token
Section titled “Create signup token”/api/signup-tokensCreate a new signup token that allows user registration
Body application/json
ttlstringrequiredA duration such as 15m or 24h, or a number of seconds
usageLimitintegerrequired1 to 100
userGroupIdsarray of strings or null
Response
7 fields
createdAtdate-time stringexpiresAtdate-time stringidstringtokenstringusageCountintegerusageLimitintegeruserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
Delete signup token
Section titled “Delete signup token”/api/signup-tokens/{id}Delete a signup token by ID
Path parameters
idstringrequiredToken ID
Response
Check initial admin setup
Section titled “Check initial admin setup”/api/signup/setupSucceeds while no admin has been set up yet and fails with setup_not_available afterwards
Response
Sign up initial admin user
Section titled “Sign up initial admin user”/api/signup/setupSign up and generate setup access token for initial admin user
Body application/json
usernamestringrequired1 to 50 characters
emailstring or nullfirstNamestringat most 50 characters
lastNamestringat most 50 characters
tokenstring
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
List users
Section titled “List users”/api/usersGet a paginated list of users with optional search and sorting
Query parameters
searchstringSearch term to filter users
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
createdAt,disabled,displayName,email,emailVerified,firstName,isAdmin,lastName,usernamesort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[disabled]array of booleansOnly items whose disabled is one of these values
filters[emailVerified]array of booleansOnly items whose emailVerified is one of these values
filters[isAdmin]array of booleansOnly items whose isAdmin is one of these values
Response
2 fields
dataarray of objects or null14 fields per item
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Create user
Section titled “Create user”/api/usersCreate a new user
Body application/json
usernamestringrequired1 to 50 characters
disabledbooleandisplayNamestringat most 100 characters
emailstring or nullemailVerifiedbooleanfirstNamestringat most 50 characters
idstringisAdminbooleanlastNamestringat most 50 characters
localestring or nulluserGroupIdsarray of strings or null
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Get current user
Section titled “Get current user”/api/users/meRetrieve information about the currently authenticated user
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Update current user
Section titled “Update current user”/api/users/meUpdate the currently authenticated user's information, where PATCH changes only the fields in the body
Body application/json
usernamestringrequired1 to 50 characters
disabledbooleandisplayNamestringat most 100 characters
emailstring or nullemailVerifiedbooleanfirstNamestringat most 50 characters
idstringisAdminbooleanlastNamestringat most 50 characters
localestring or nulluserGroupIdsarray of strings or null
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Update current user
Section titled “Update current user”/api/users/meUpdate the currently authenticated user's information, where PATCH changes only the fields in the body
Body application/json, application/merge-patch+json
disabledbooleandisplayNamestringat most 100 characters
emailstring or nullemailVerifiedbooleanfirstNamestringat most 50 characters
idstringisAdminbooleanlastNamestringat most 50 characters
localestring or nulluserGroupIdsarray of strings or nullusernamestring1 to 50 characters
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Get pending email change
Section titled “Get pending email change”/api/users/me/email-changeGet the email change of the currently authenticated user that still has to be confirmed through the emailed link
Responses
2 fields
emailstringexpiresAtdate-time string
Cancel pending email change
Section titled “Cancel pending email change”/api/users/me/email-changeCancel the pending email change of the currently authenticated user, so its verification link stops working
Response
Update current user's profile picture
Section titled “Update current user's profile picture”/api/users/me/profile-pictureUpdate the currently authenticated user's profile picture
Body multipart/form-data
filebinaryrequiredProfile picture image file (PNG, JPG, or JPEG)
Response
Reset current user's profile picture
Section titled “Reset current user's profile picture”/api/users/me/profile-pictureReset the currently authenticated user's profile picture to the default
Response
Send email verification
Section titled “Send email verification”/api/users/me/send-email-verificationSend an email verification to the currently authenticated user
Response
Verify email
Section titled “Verify email”/api/users/me/verify-emailVerify the currently authenticated user's email using a verification token
Body application/json
tokenstringrequired
Response
Get user by ID
Section titled “Get user by ID”/api/users/{id}Retrieve detailed information about a specific user
Path parameters
idstringrequiredUser ID
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Update user
Section titled “Update user”/api/users/{id}Update an existing user by ID, where PATCH changes only the fields in the body
Path parameters
idstringrequiredUser ID
Body application/json
usernamestringrequired1 to 50 characters
disabledbooleandisplayNamestringat most 100 characters
emailstring or nullemailVerifiedbooleanfirstNamestringat most 50 characters
idstringisAdminbooleanlastNamestringat most 50 characters
localestring or nulluserGroupIdsarray of strings or null
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Update user
Section titled “Update user”/api/users/{id}Update an existing user by ID, where PATCH changes only the fields in the body
Path parameters
idstringrequiredUser ID
Body application/json, application/merge-patch+json
disabledbooleandisplayNamestringat most 100 characters
emailstring or nullemailVerifiedbooleanfirstNamestringat most 50 characters
idstringisAdminbooleanlastNamestringat most 50 characters
localestring or nulluserGroupIdsarray of strings or nullusernamestring1 to 50 characters
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Delete user
Section titled “Delete user”/api/users/{id}Delete a specific user by ID
Path parameters
idstringrequiredUser ID
Response
Get user groups
Section titled “Get user groups”/api/users/{id}/groupsRetrieve all groups a specific user belongs to
Path parameters
idstringrequiredUser ID
Response
8 fields per item
allowedOidcClientsarray of objects or null8 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringusersarray of objects or null14 fields per item
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Request one-time access email (admin)
Section titled “Request one-time access email (admin)”/api/users/{id}/one-time-access-emailRequest a one-time access email for a specific user (admin only)
Path parameters
idstringrequiredUser ID
Body application/json
ttlstringA duration such as 15m or 24h, or a number of seconds
Response
Create one-time access token for user (admin)
Section titled “Create one-time access token for user (admin)”/api/users/{id}/one-time-access-tokenGenerate a one-time access token for a specific user (admin only)
Path parameters
idstringrequiredUser ID
Body application/json
ttlstringA duration such as 15m or 24h, or a number of seconds
Response
1 field
tokenstring
Update user profile picture
Section titled “Update user profile picture”/api/users/{id}/profile-pictureUpdate a specific user's profile picture
Path parameters
idstringrequiredUser ID
Body multipart/form-data
filebinaryrequiredProfile picture image file (PNG, JPG, or JPEG)
Response
Reset user profile picture
Section titled “Reset user profile picture”/api/users/{id}/profile-pictureReset a specific user's profile picture to the default
Path parameters
idstringrequiredUser ID
Response
Get user profile picture
Section titled “Get user profile picture”/api/users/{id}/profile-picture.pngRetrieve a specific user's profile picture
Path parameters
idstringrequiredUser ID
Response
Update user groups
Section titled “Update user groups”/api/users/{id}/user-groupsUpdate the groups a specific user belongs to
Path parameters
idstringrequiredUser ID
Body application/json
userGroupIdsarray of stringsrequired
Response
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
List user passkeys
Section titled “List user passkeys”/api/users/{id}/webauthn-credentialsRetrieve all WebAuthn credentials for a specific user
Path parameters
idstringrequiredUser ID
Response
10 fields per item
aaguidstringattestationTypestringbackupEligiblebooleanbackupStatebooleancreatedAtdate-time stringcredentialIDstringhasIconbooleanidstringnamestringtransportarray of strings or null
Delete user passkey
Section titled “Delete user passkey”/api/users/{id}/webauthn-credentials/{credentialId}Delete a specific WebAuthn credential for a user
Path parameters
idstringrequiredUser ID
credentialIdstringrequiredCredential ID
Response
User Groups
Section titled “User Groups”Groups and their members.
- get
/api/user-groupsList user groups - post
/api/user-groupsCreate user group - get
/api/user-groups/{id}Get user group by ID - put
/api/user-groups/{id}Update user group - patch
/api/user-groups/{id}Update user group - delete
/api/user-groups/{id}Delete user group - put
/api/user-groups/{id}/usersUpdate users in a group
List user groups
Section titled “List user groups”/api/user-groupsGet a paginated list of user groups with optional search and sorting
Query parameters
searchstringSearch term to filter user groups by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
createdAt,friendlyName,name,userCountsort[direction]stringSort direction
One of
asc,desc· defaults toasc
Response
2 fields
dataarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Create user group
Section titled “Create user group”/api/user-groupsCreate a new user group
Body application/json
friendlyNamestringrequired2 to 50 characters
namestringrequired2 to 255 characters
Response
8 fields
allowedOidcClientsarray of objects or null8 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringusersarray of objects or null14 fields per item
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Get user group by ID
Section titled “Get user group by ID”/api/user-groups/{id}Retrieve detailed information about a specific user group including its users
Path parameters
idstringrequiredUser Group ID
Response
8 fields
allowedOidcClientsarray of objects or null8 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringusersarray of objects or null14 fields per item
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Update user group
Section titled “Update user group”/api/user-groups/{id}Update an existing user group by ID, where PATCH changes only the fields in the body
Path parameters
idstringrequiredUser Group ID
Body application/json
friendlyNamestringrequired2 to 50 characters
namestringrequired2 to 255 characters
Response
8 fields
allowedOidcClientsarray of objects or null8 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringusersarray of objects or null14 fields per item
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Update user group
Section titled “Update user group”/api/user-groups/{id}Update an existing user group by ID, where PATCH changes only the fields in the body
Path parameters
idstringrequiredUser Group ID
Body application/json, application/merge-patch+json
friendlyNamestring2 to 50 characters
namestring2 to 255 characters
Response
8 fields
allowedOidcClientsarray of objects or null8 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringusersarray of objects or null14 fields per item
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Delete user group
Section titled “Delete user group”/api/user-groups/{id}Delete a specific user group by ID
Path parameters
idstringrequiredUser Group ID
Response
Update users in a group
Section titled “Update users in a group”/api/user-groups/{id}/usersUpdate the list of users belonging to a specific user group
Path parameters
idstringrequiredUser Group ID
Body application/json
userIdsarray of stringsrequired
Response
8 fields
allowedOidcClientsarray of objects or null8 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringusersarray of objects or null14 fields per item
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
OIDC clients with their secrets, logos and allowed groups, plus the clients each user has authorized.
- get
/api/oidc/clientsList OIDC clients - post
/api/oidc/clientsCreate OIDC client - get
/api/oidc/clients/{id}Get OIDC client - put
/api/oidc/clients/{id}Update OIDC client - patch
/api/oidc/clients/{id}Update OIDC client - delete
/api/oidc/clients/{id}Delete OIDC client - put
/api/oidc/clients/{id}/allowed-user-groupsUpdate allowed user groups - get
/api/oidc/clients/{id}/logoGet client logo - post
/api/oidc/clients/{id}/logoUpdate client logo - delete
/api/oidc/clients/{id}/logoDelete client logo - get
/api/oidc/clients/{id}/preview/{userId}Preview OIDC client data for user - post
/api/oidc/clients/{id}/refreshRefresh client metadata document - get
/api/oidc/clients/{id}/scim-service-providerGet SCIM service provider - get
/api/oidc/clients/{id}/secretsList client secrets - post
/api/oidc/clients/{id}/secretsCreate client secret - delete
/api/oidc/clients/{id}/secrets/{secretId}Delete client secret - post
/api/oidc/introspectIntrospect OIDC tokens - get
/api/oidc/logo-presetsSearch logo presets - get
/api/oidc/userinfoGet user information - get
/api/oidc/users/me/authorized-clientsList authorized clients for current user - delete
/api/oidc/users/me/authorized-clients/{clientId}Revoke authorization for an OIDC client - get
/api/oidc/users/me/clientsList accessible OIDC clients for current user - get
/api/oidc/users/{id}/authorized-clientsList authorized clients for a user - put
/api/user-groups/{id}/allowed-oidc-clientsUpdate allowed OIDC clients
List OIDC clients
Section titled “List OIDC clients”/api/oidc/clientsGet a paginated list of OIDC clients with optional search and sorting
Query parameters
searchstringSearch term to filter clients by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
allowedUserGroups,clientType,createdAt,disabled,isGroupRestricted,name,pkceEnabled,pkceSupported,requiresPushedAuthorizationRequests,requiresReauthentication,skipConsentsort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[clientType]array of stringsOnly items whose clientType is one of these values
filters[disabled]array of booleansOnly items whose disabled is one of these values
filters[isGroupRestricted]array of booleansOnly items whose isGroupRestricted is one of these values
filters[pkceEnabled]array of booleansOnly items whose pkceEnabled is one of these values
filters[pkceSupported]array of booleansOnly items whose pkceSupported is one of these values
filters[requiresPushedAuthorizationRequests]array of booleansOnly items whose requiresPushedAuthorizationRequests is one of these values
filters[requiresReauthentication]array of booleansOnly items whose requiresReauthentication is one of these values
filters[skipConsent]array of booleansOnly items whose skipConsent is one of these values
Response
2 fields
dataarray of objects or null23 fields per item
accessTokenDurationMinutesintegerallowedUserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
backchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringclientTypestringcredentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
descriptionstringdisabledbooleanhasDarkLogobooleanhasLogobooleanidstringisGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoutCallbackURLsarray of strings or nullnamestringpkceEnabledbooleanpkceSupportedbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Create OIDC client
Section titled “Create OIDC client”/api/oidc/clientsCreate a new OIDC client
Body application/json
namestringrequiredat most 50 characters
accessTokenDurationMinutesintegerbackchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringcredentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
darkLogoUrlstring or nulldescriptionstringat most 150 characters
disabledbooleanhasDarkLogobooleanhasLogobooleanidstring2 to 128 characters
isGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoUrlstring or nulllogoutCallbackURLsarray of strings or nullpkceEnabledbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
Response
24 fields
accessTokenDurationMinutesintegerallowedUserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
backchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringclientTypestringcreatedSecretobject6 fields
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstringsecretstring
credentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
descriptionstringdisabledbooleanhasDarkLogobooleanhasLogobooleanidstringisGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoutCallbackURLsarray of strings or nullnamestringpkceEnabledbooleanpkceSupportedbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
Get OIDC client
Section titled “Get OIDC client”/api/oidc/clients/{id}Get detailed information about an OIDC client
Path parameters
idstringrequiredClient ID
Response
23 fields
accessTokenDurationMinutesintegerallowedUserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
backchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringclientTypestringcredentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
descriptionstringdisabledbooleanhasDarkLogobooleanhasLogobooleanidstringisGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoutCallbackURLsarray of strings or nullnamestringpkceEnabledbooleanpkceSupportedbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
Update OIDC client
Section titled “Update OIDC client”/api/oidc/clients/{id}Update an existing OIDC client, where PATCH changes only the fields in the body
Path parameters
idstringrequiredClient ID
Body application/json
namestringrequiredat most 50 characters
accessTokenDurationMinutesintegerbackchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringcredentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
darkLogoUrlstring or nulldescriptionstringat most 150 characters
disabledbooleanhasDarkLogobooleanhasLogobooleanisGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoUrlstring or nulllogoutCallbackURLsarray of strings or nullpkceEnabledbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
Response
23 fields
accessTokenDurationMinutesintegerallowedUserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
backchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringclientTypestringcredentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
descriptionstringdisabledbooleanhasDarkLogobooleanhasLogobooleanidstringisGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoutCallbackURLsarray of strings or nullnamestringpkceEnabledbooleanpkceSupportedbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
Update OIDC client
Section titled “Update OIDC client”/api/oidc/clients/{id}Update an existing OIDC client, where PATCH changes only the fields in the body
Path parameters
idstringrequiredClient ID
Body application/json, application/merge-patch+json
accessTokenDurationMinutesintegerbackchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringcredentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
darkLogoUrlstring or nulldescriptionstringat most 150 characters
disabledbooleanhasDarkLogobooleanhasLogobooleanisGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoUrlstring or nulllogoutCallbackURLsarray of strings or nullnamestringat most 50 characters
pkceEnabledbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
Response
23 fields
accessTokenDurationMinutesintegerallowedUserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
backchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringclientTypestringcredentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
descriptionstringdisabledbooleanhasDarkLogobooleanhasLogobooleanidstringisGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoutCallbackURLsarray of strings or nullnamestringpkceEnabledbooleanpkceSupportedbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
Delete OIDC client
Section titled “Delete OIDC client”/api/oidc/clients/{id}Delete an OIDC client by ID
Path parameters
idstringrequiredClient ID
Response
Update allowed user groups
Section titled “Update allowed user groups”/api/oidc/clients/{id}/allowed-user-groupsUpdate the user groups allowed to access an OIDC client
Path parameters
idstringrequiredClient ID
Body application/json
userGroupIdsarray of stringsrequired
Response
22 fields
accessTokenDurationMinutesintegerbackchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringclientTypestringcredentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
descriptionstringdisabledbooleanhasDarkLogobooleanhasLogobooleanidstringisGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoutCallbackURLsarray of strings or nullnamestringpkceEnabledbooleanpkceSupportedbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
Get client logo
Section titled “Get client logo”/api/oidc/clients/{id}/logoGet the logo image for an OIDC client
Path parameters
idstringrequiredClient ID
Query parameters
lightbooleanLight mode logo (true) or dark mode logo (false)
defaults to
true
Response
Update client logo
Section titled “Update client logo”/api/oidc/clients/{id}/logoUpload or update the logo for an OIDC client
Path parameters
idstringrequiredClient ID
Query parameters
lightbooleanLight mode logo (true) or dark mode logo (false)
defaults to
true
Body multipart/form-data
filebinaryrequiredLogo image file (PNG, JPG, or SVG)
Response
Delete client logo
Section titled “Delete client logo”/api/oidc/clients/{id}/logoDelete the logo for an OIDC client
Path parameters
idstringrequiredClient ID
Query parameters
lightbooleanLight mode logo (true) or dark mode logo (false)
defaults to
true
Response
Preview OIDC client data for user
Section titled “Preview OIDC client data for user”/api/oidc/clients/{id}/preview/{userId}Get a preview of the OIDC data (ID token, access token, userinfo) that would be sent to the client for a specific user
Path parameters
idstringrequiredClient ID
userIdstringrequiredUser ID to preview data for
Query parameters
scopesstringScopes to include in the preview (space-separated)
Response
3 fields
accessTokenmap of values or nullidTokenmap of values or nulluserInfomap of values or null
Refresh client metadata document
Section titled “Refresh client metadata document”/api/oidc/clients/{id}/refreshForce a re-fetch of the OAuth Client ID Metadata Document for a CIMD client
Path parameters
idstringrequiredClient ID
Response
23 fields
accessTokenDurationMinutesintegerallowedUserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
backchannelLogoutURLstringcallbackURLsarray of strings or nullclaimMappingPolicyIdstringclientTypestringcredentialsobject2 fields
federatedIdentitiesarray of objects or null6 fields per item
audiencestringissuerstringjwksstringpublicKeysarray of values or nullreplayProtectionbooleansubjectstring
secretsarray of objects or null5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
descriptionstringdisabledbooleanhasDarkLogobooleanhasLogobooleanidstringisGroupRestrictedbooleanisPublicbooleanlaunchURLstring or nulllogoutCallbackURLsarray of strings or nullnamestringpkceEnabledbooleanpkceSupportedbooleanrefreshTokenDurationMinutesintegerrequiresPushedAuthorizationRequestsbooleanrequiresReauthenticationbooleanskipConsentboolean
Get SCIM service provider
Section titled “Get SCIM service provider”/api/oidc/clients/{id}/scim-service-providerGet the SCIM service provider configuration for an OIDC client
Path parameters
idstringrequiredClient ID
Response
5 fields
createdAtdate-time stringendpointstringhasTokenbooleanidstringlastSyncedAtdate-time string or null
List client secrets
Section titled “List client secrets”/api/oidc/clients/{id}/secretsList the secrets of an OIDC client, without disclosing their values
Path parameters
idstringrequiredClient ID
Response
5 fields per item
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstring
Create client secret
Section titled “Create client secret”/api/oidc/clients/{id}/secretsAdd a new secret to an OIDC client, leaving the existing ones usable. The value is only returned by this endpoint and cannot be retrieved later.
Path parameters
idstringrequiredClient ID
Body application/json
expiresAtdate-time string or nullsecretstringat least 16 characters
Response
6 fields
createdAtdate-time stringexpiresAtdate-time string or nullidstringisActivebooleanprefixstringsecretstring
Delete client secret
Section titled “Delete client secret”/api/oidc/clients/{id}/secrets/{secretId}Delete a single secret of an OIDC client, making it immediately unusable
Path parameters
idstringrequiredClient ID
secretIdstringrequiredClient secret ID
Response
Introspect OIDC tokens
Section titled “Introspect OIDC tokens”/api/oidc/introspectPass a token to verify if it is considered valid.
Body application/x-www-form-urlencoded
tokenstringrequiredThe token to be introspected
client_idstringThe client whose federated client assertion is sent as the bearer token
scopestringSpace-separated scopes the token must have
token_type_hintstringThe type of the token, access_token or refresh_token
Response
Search logo presets
Section titled “Search logo presets”/api/oidc/logo-presetsSearch the icon library for logos that can be used for OIDC clients
Query parameters
searchstringSearch term matched against the icon name
Response
4 fields per item
darkLogoUrlstring or nulllogoUrlstringnamestringreferencestring
Get user information
Section titled “Get user information”/api/oidc/userinfoGet user information based on the access token
Response
List authorized clients for current user
Section titled “List authorized clients for current user”/api/oidc/users/me/authorized-clientsGet a paginated list of OIDC clients that the current user has authorized
Query parameters
searchstringSearch term to filter clients by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
lastUsedAt,namesort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[hasLaunchURL]booleanFilter clients by whether a launch URL is configured
Response
2 fields
dataarray of objects or null3 fields per item
clientobject8 fields
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
lastUsedAtdate-time stringscopestring
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Revoke authorization for an OIDC client
Section titled “Revoke authorization for an OIDC client”/api/oidc/users/me/authorized-clients/{clientId}Revoke the authorization for a specific OIDC client for the current user
Path parameters
clientIdstringrequiredClient ID to revoke authorization for
Response
List accessible OIDC clients for current user
Section titled “List accessible OIDC clients for current user”/api/oidc/users/me/clientsGet a list of OIDC clients that the current user can access
Query parameters
searchstringSearch term to filter clients by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
clientType,createdAt,disabled,isGroupRestricted,lastUsedAt,name,pkceEnabled,pkceSupported,requiresPushedAuthorizationRequests,requiresReauthentication,skipConsentsort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[clientType]array of stringsOnly items whose clientType is one of these values
filters[disabled]array of booleansOnly items whose disabled is one of these values
filters[isGroupRestricted]array of booleansOnly items whose isGroupRestricted is one of these values
filters[pkceEnabled]array of booleansOnly items whose pkceEnabled is one of these values
filters[pkceSupported]array of booleansOnly items whose pkceSupported is one of these values
filters[requiresPushedAuthorizationRequests]array of booleansOnly items whose requiresPushedAuthorizationRequests is one of these values
filters[requiresReauthentication]array of booleansOnly items whose requiresReauthentication is one of these values
filters[skipConsent]array of booleansOnly items whose skipConsent is one of these values
filters[hasLaunchURL]booleanFilter clients by whether a launch URL is configured
Response
2 fields
dataarray of objects or null9 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlastUsedAtdate-time string or nulllaunchURLstring or nullnamestringrequiresReauthenticationboolean
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
List authorized clients for a user
Section titled “List authorized clients for a user”/api/oidc/users/{id}/authorized-clientsGet a paginated list of OIDC clients that a specific user has authorized
Path parameters
idstringrequiredUser ID
Query parameters
searchstringSearch term to filter clients by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
lastUsedAt,namesort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[hasLaunchURL]booleanFilter clients by whether a launch URL is configured
Response
2 fields
dataarray of objects or null3 fields per item
clientobject8 fields
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
lastUsedAtdate-time stringscopestring
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Update allowed OIDC clients
Section titled “Update allowed OIDC clients”/api/user-groups/{id}/allowed-oidc-clientsUpdate the OIDC clients allowed for a specific user group
Path parameters
idstringrequiredUser Group ID
Body application/json
oidcClientIdsarray of stringsrequired
Response
8 fields
allowedOidcClientsarray of objects or null8 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringusersarray of objects or null14 fields per item
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
OIDC Custom Scopes
Section titled “OIDC Custom Scopes”Scopes of your own that clients can request besides the built-in ones.
- get
/api/oidc/custom-scopesList custom OIDC scopes - post
/api/oidc/custom-scopesCreate a custom OIDC scope - get
/api/oidc/custom-scopes/keysList the keys of all custom OIDC scopes - put
/api/oidc/custom-scopes/{id}Update a custom OIDC scope - patch
/api/oidc/custom-scopes/{id}Update a custom OIDC scope - delete
/api/oidc/custom-scopes/{id}Delete a custom OIDC scope
List custom OIDC scopes
Section titled “List custom OIDC scopes”/api/oidc/custom-scopesGet a paginated list of the custom OIDC scopes with optional search and sorting
Query parameters
searchstringSearch term to filter scopes by key or name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
createdAt,key,namesort[direction]stringSort direction
One of
asc,desc· defaults toasc
Response
2 fields
dataarray of objects or null6 fields per item
createdAtdate-time stringdescriptionstringat most 1000 characters
idstringkeystringat most 128 characters
namestringat most 255 characters
policiesarray of strings or null
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Create a custom OIDC scope
Section titled “Create a custom OIDC scope”/api/oidc/custom-scopesCreate a custom OIDC scope, which claim mappings can then be released with
Body application/json
descriptionstringrequiredat most 1000 characters
keystringrequiredat most 128 characters
namestringrequiredat most 255 characters
createdAtdate-time stringidstringpoliciesarray of strings or null
Response
6 fields
createdAtdate-time stringdescriptionstringat most 1000 characters
idstringkeystringat most 128 characters
namestringat most 255 characters
policiesarray of strings or null
List the keys of all custom OIDC scopes
Section titled “List the keys of all custom OIDC scopes”/api/oidc/custom-scopes/keysGet the keys of every custom OIDC scope, sorted, for pickers that offer all of them at once
Response
Update a custom OIDC scope
Section titled “Update a custom OIDC scope”/api/oidc/custom-scopes/{id}Update the name and description of a custom OIDC scope, whose key can't change, where PATCH changes only the fields in the body
Path parameters
idstringrequiredCustom scope ID
Body application/json
descriptionstringrequiredat most 1000 characters
keystringrequiredat most 128 characters
namestringrequiredat most 255 characters
createdAtdate-time stringidstringpoliciesarray of strings or null
Response
6 fields
createdAtdate-time stringdescriptionstringat most 1000 characters
idstringkeystringat most 128 characters
namestringat most 255 characters
policiesarray of strings or null
Update a custom OIDC scope
Section titled “Update a custom OIDC scope”/api/oidc/custom-scopes/{id}Update the name and description of a custom OIDC scope, whose key can't change, where PATCH changes only the fields in the body
Path parameters
idstringrequiredCustom scope ID
Body application/json, application/merge-patch+json
createdAtdate-time stringdescriptionstringat most 1000 characters
idstringkeystringat most 128 characters
namestringat most 255 characters
policiesarray of strings or null
Response
6 fields
createdAtdate-time stringdescriptionstringat most 1000 characters
idstringkeystringat most 128 characters
namestringat most 255 characters
policiesarray of strings or null
Delete a custom OIDC scope
Section titled “Delete a custom OIDC scope”/api/oidc/custom-scopes/{id}Delete a custom OIDC scope that no claim mapping is released with
Path parameters
idstringrequiredCustom scope ID
Response
OIDC Claim Mapping Policies
Section titled “OIDC Claim Mapping Policies”Policies that decide which claims the tokens of a scope carry and who may request it.
- get
/api/oidc/claim-mapping-policiesList OIDC claim mapping policies - post
/api/oidc/claim-mapping-policiesCreate OIDC claim mapping policy - post
/api/oidc/claim-mapping-policies/previewPreview claim mappings - get
/api/oidc/claim-mapping-policies/{id}Get an OIDC claim mapping policy - put
/api/oidc/claim-mapping-policies/{id}Update an OIDC claim mapping policy - patch
/api/oidc/claim-mapping-policies/{id}Update an OIDC claim mapping policy - delete
/api/oidc/claim-mapping-policies/{id}Delete an OIDC claim mapping policy - get
/api/oidc/claim-mapping-policies/{id}/assignable-clientsList OIDC clients that can still be assigned to a claim mapping policy - get
/api/oidc/claim-mapping-policies/{id}/clientsList OIDC clients using a claim mapping policy - post
/api/oidc/claim-mapping-policies/{id}/clients/{clientId}Assign an OIDC client to a claim mapping policy - delete
/api/oidc/claim-mapping-policies/{id}/clients/{clientId}Detach an OIDC client from a claim mapping policy
List OIDC claim mapping policies
Section titled “List OIDC claim mapping policies”/api/oidc/claim-mapping-policiesGet a paginated list of OIDC claim mapping policies with optional search and sorting
Query parameters
searchstringSearch term to filter claim mapping policies by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
createdAt,isDefault,namesort[direction]stringSort direction
One of
asc,desc· defaults toasc
Response
2 fields
dataarray of objects or null6 fields per item
claimCountintegerclientCountintegercreatedAtdate-time stringidstringisDefaultbooleannamestringat most 255 characters
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Create OIDC claim mapping policy
Section titled “Create OIDC claim mapping policy”/api/oidc/claim-mapping-policiesCreate a new OIDC claim mapping policy
Body application/json
namestringrequiredat most 255 characters
claimCountintegerclaimMappingsarray of objects or null7 fields per item
claimNamestringrequiredat most 255 characters
sourceTypestringrequiredOne of
user_field,custom_claim,staticsourceValuestringrequiredat most 255 characters
accessTokenbooleanidTokenbooleanscopearray of stringsat least 1 items
userInfoboolean
clientCountintegercreatedAtdate-time stringidstringisDefaultboolean
Response
7 fields
claimCountintegerclaimMappingsarray of objects or null7 fields per item
accessTokenbooleanclaimNamestringat most 255 characters
idTokenbooleanscopearray of stringsat least 1 items
sourceTypestringOne of
user_field,custom_claim,staticsourceValuestringat most 255 characters
userInfoboolean
clientCountintegercreatedAtdate-time stringidstringisDefaultbooleannamestringat most 255 characters
Preview claim mappings
Section titled “Preview claim mappings”/api/oidc/claim-mapping-policies/previewGet the claims that claim mappings, saved or not, release for a user and set of scopes
Body application/json
userIdstringrequiredclaimMappingsarray of objects or null7 fields per item
claimNamestringrequiredat most 255 characters
sourceTypestringrequiredOne of
user_field,custom_claim,staticsourceValuestringrequiredat most 255 characters
accessTokenbooleanidTokenbooleanscopearray of stringsat least 1 items
userInfoboolean
scopesarray of strings or null
Response
3 fields
accessTokenmap of values or nullidTokenmap of values or nulluserInfomap of values or null
Get an OIDC claim mapping policy
Section titled “Get an OIDC claim mapping policy”/api/oidc/claim-mapping-policies/{id}Retrieve an existing OIDC claim mapping policy
Path parameters
idstringrequiredClaim mapping policy ID
Response
7 fields
claimCountintegerclaimMappingsarray of objects or null7 fields per item
accessTokenbooleanclaimNamestringat most 255 characters
idTokenbooleanscopearray of stringsat least 1 items
sourceTypestringOne of
user_field,custom_claim,staticsourceValuestringat most 255 characters
userInfoboolean
clientCountintegercreatedAtdate-time stringidstringisDefaultbooleannamestringat most 255 characters
Update an OIDC claim mapping policy
Section titled “Update an OIDC claim mapping policy”/api/oidc/claim-mapping-policies/{id}Update an existing OIDC claim mapping policy, where PATCH changes only the fields in the body
Path parameters
idstringrequiredClaim mapping policy ID
Body application/json
namestringrequiredat most 255 characters
claimCountintegerclaimMappingsarray of objects or null7 fields per item
claimNamestringrequiredat most 255 characters
sourceTypestringrequiredOne of
user_field,custom_claim,staticsourceValuestringrequiredat most 255 characters
accessTokenbooleanidTokenbooleanscopearray of stringsat least 1 items
userInfoboolean
clientCountintegercreatedAtdate-time stringidstringisDefaultboolean
Response
7 fields
claimCountintegerclaimMappingsarray of objects or null7 fields per item
accessTokenbooleanclaimNamestringat most 255 characters
idTokenbooleanscopearray of stringsat least 1 items
sourceTypestringOne of
user_field,custom_claim,staticsourceValuestringat most 255 characters
userInfoboolean
clientCountintegercreatedAtdate-time stringidstringisDefaultbooleannamestringat most 255 characters
Update an OIDC claim mapping policy
Section titled “Update an OIDC claim mapping policy”/api/oidc/claim-mapping-policies/{id}Update an existing OIDC claim mapping policy, where PATCH changes only the fields in the body
Path parameters
idstringrequiredClaim mapping policy ID
Body application/json, application/merge-patch+json
claimCountintegerclaimMappingsarray of objects or null7 fields per item
claimNamestringrequiredat most 255 characters
sourceTypestringrequiredOne of
user_field,custom_claim,staticsourceValuestringrequiredat most 255 characters
accessTokenbooleanidTokenbooleanscopearray of stringsat least 1 items
userInfoboolean
clientCountintegercreatedAtdate-time stringidstringisDefaultbooleannamestringat most 255 characters
Response
7 fields
claimCountintegerclaimMappingsarray of objects or null7 fields per item
accessTokenbooleanclaimNamestringat most 255 characters
idTokenbooleanscopearray of stringsat least 1 items
sourceTypestringOne of
user_field,custom_claim,staticsourceValuestringat most 255 characters
userInfoboolean
clientCountintegercreatedAtdate-time stringidstringisDefaultbooleannamestringat most 255 characters
Delete an OIDC claim mapping policy
Section titled “Delete an OIDC claim mapping policy”/api/oidc/claim-mapping-policies/{id}Delete an OIDC claim mapping policy by ID
Path parameters
idstringrequiredClaim mapping policy ID
Response
List OIDC clients that can still be assigned to a claim mapping policy
Section titled “List OIDC clients that can still be assigned to a claim mapping policy”/api/oidc/claim-mapping-policies/{id}/assignable-clientsGet a paginated list of the OIDC clients that are not on this claim mapping policy yet
Path parameters
idstringrequiredClaim mapping policy ID
Query parameters
searchstringSearch term to filter clients by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
clientType,createdAt,disabled,isGroupRestricted,name,pkceEnabled,pkceSupported,requiresPushedAuthorizationRequests,requiresReauthentication,skipConsentsort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[clientType]array of stringsOnly items whose clientType is one of these values
filters[disabled]array of booleansOnly items whose disabled is one of these values
filters[isGroupRestricted]array of booleansOnly items whose isGroupRestricted is one of these values
filters[pkceEnabled]array of booleansOnly items whose pkceEnabled is one of these values
filters[pkceSupported]array of booleansOnly items whose pkceSupported is one of these values
filters[requiresPushedAuthorizationRequests]array of booleansOnly items whose requiresPushedAuthorizationRequests is one of these values
filters[requiresReauthentication]array of booleansOnly items whose requiresReauthentication is one of these values
filters[skipConsent]array of booleansOnly items whose skipConsent is one of these values
Response
2 fields
dataarray of objects or null8 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
List OIDC clients using a claim mapping policy
Section titled “List OIDC clients using a claim mapping policy”/api/oidc/claim-mapping-policies/{id}/clientsGet a paginated list of the OIDC clients assigned to a claim mapping policy
Path parameters
idstringrequiredClaim mapping policy ID
Query parameters
searchstringSearch term to filter clients by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
clientType,createdAt,disabled,isGroupRestricted,name,pkceEnabled,pkceSupported,requiresPushedAuthorizationRequests,requiresReauthentication,skipConsentsort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[clientType]array of stringsOnly items whose clientType is one of these values
filters[disabled]array of booleansOnly items whose disabled is one of these values
filters[isGroupRestricted]array of booleansOnly items whose isGroupRestricted is one of these values
filters[pkceEnabled]array of booleansOnly items whose pkceEnabled is one of these values
filters[pkceSupported]array of booleansOnly items whose pkceSupported is one of these values
filters[requiresPushedAuthorizationRequests]array of booleansOnly items whose requiresPushedAuthorizationRequests is one of these values
filters[requiresReauthentication]array of booleansOnly items whose requiresReauthentication is one of these values
filters[skipConsent]array of booleansOnly items whose skipConsent is one of these values
Response
2 fields
dataarray of objects or null8 fields per item
clientTypestringdescriptionstringhasDarkLogobooleanhasLogobooleanidstringlaunchURLstring or nullnamestringrequiresReauthenticationboolean
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Assign an OIDC client to a claim mapping policy
Section titled “Assign an OIDC client to a claim mapping policy”/api/oidc/claim-mapping-policies/{id}/clients/{clientId}Point an OIDC client at this claim mapping policy, replacing the policy it was on
Path parameters
idstringrequiredClaim mapping policy ID
clientIdstringrequiredOIDC Client ID
Response
Detach an OIDC client from a claim mapping policy
Section titled “Detach an OIDC client from a claim mapping policy”/api/oidc/claim-mapping-policies/{id}/clients/{clientId}Remove an OIDC client from this claim mapping policy, so it falls back to the default one
Path parameters
idstringrequiredClaim mapping policy ID
clientIdstringrequiredOIDC Client ID
Response
Your own APIs, their permissions and the clients that may request them.
- get
/api/api-access/{clientId}/apisList APIs a client may access - get
/api/api-access/{clientId}/assignable-apisList APIs a client can still be granted access to - get
/api/apisList APIs - post
/api/apisCreate API - get
/api/apis/{id}Get API by ID - put
/api/apis/{id}Update API - patch
/api/apis/{id}Update API - delete
/api/apis/{id}Delete API - get
/api/apis/{id}/assignable-clientsList clients that can still be granted access to an API - put
/api/apis/{id}/cimd-accessUpdate metadata document client access - get
/api/apis/{id}/clientsList clients with access to an API - put
/api/apis/{id}/clients/{clientId}Update a client's access to an API - delete
/api/apis/{id}/clients/{clientId}Revoke a client's access to an API - put
/api/apis/{id}/permissionsUpdate API permissions
List APIs a client may access
Section titled “List APIs a client may access”/api/api-access/{clientId}/apisGet every API the OIDC client may request tokens for, with its access and permissions split into user-delegated and client (machine-to-machine) access
Path parameters
clientIdstringrequiredOIDC Client ID
Response
7 fields per item
apiobject6 fields
allowCimdClientsbooleancreatedAtdate-time stringidstringnamestringpermissionsarray of objects or null5 fields per item
allowedForCimdClientsbooleandescriptionstring or nullidstringkeystringnamestring
resourcestring
cimdGrantedAccessbooleancimdGrantedPermissionIdsarray of strings or nullclientAccessbooleanclientPermissionIdsarray of strings or nulluserDelegatedAccessbooleanuserDelegatedPermissionIdsarray of strings or null
List APIs a client can still be granted access to
Section titled “List APIs a client can still be granted access to”/api/api-access/{clientId}/assignable-apisGet a paginated list of APIs the OIDC client cannot already reach
Path parameters
clientIdstringrequiredOIDC Client ID
Query parameters
searchstringSearch term to filter APIs by name or resource
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
audience,createdAt,name,resourcesort[direction]stringSort direction
One of
asc,desc· defaults toasc
Response
2 fields
dataarray of objects or null6 fields per item
allowCimdClientsbooleancreatedAtdate-time stringidstringnamestringpermissionsarray of objects or null5 fields per item
allowedForCimdClientsbooleandescriptionstring or nullidstringkeystringnamestring
resourcestring
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
List APIs
Section titled “List APIs”/api/apisGet a paginated list of APIs with optional search and sorting
Query parameters
searchstringSearch term to filter APIs by name or resource
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
audience,createdAt,name,resourcesort[direction]stringSort direction
One of
asc,desc· defaults toasc
Response
2 fields
dataarray of objects or null6 fields per item
allowCimdClientsbooleancreatedAtdate-time stringidstringnamestringpermissionsarray of objects or null5 fields per item
allowedForCimdClientsbooleandescriptionstring or nullidstringkeystringnamestring
resourcestring
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Create API
Section titled “Create API”/api/apisCreate a new API resource server
Body application/json
namestringrequired1 to 50 characters
resourcestringrequiredat most 350 characters
Response
6 fields
allowCimdClientsbooleancreatedAtdate-time stringidstringnamestringpermissionsarray of objects or null5 fields per item
allowedForCimdClientsbooleandescriptionstring or nullidstringkeystringnamestring
resourcestring
Get API by ID
Section titled “Get API by ID”/api/apis/{id}Retrieve a single API including its permissions
Path parameters
idstringrequiredAPI ID
Response
6 fields
allowCimdClientsbooleancreatedAtdate-time stringidstringnamestringpermissionsarray of objects or null5 fields per item
allowedForCimdClientsbooleandescriptionstring or nullidstringkeystringnamestring
resourcestring
Update API
Section titled “Update API”/api/apis/{id}Update an existing API by ID, where PATCH changes only the fields in the body
Path parameters
idstringrequiredAPI ID
Body application/json
namestringrequired1 to 50 characters
Response
6 fields
allowCimdClientsbooleancreatedAtdate-time stringidstringnamestringpermissionsarray of objects or null5 fields per item
allowedForCimdClientsbooleandescriptionstring or nullidstringkeystringnamestring
resourcestring
Update API
Section titled “Update API”/api/apis/{id}Update an existing API by ID, where PATCH changes only the fields in the body
Path parameters
idstringrequiredAPI ID
Body application/json, application/merge-patch+json
namestring1 to 50 characters
Response
6 fields
allowCimdClientsbooleancreatedAtdate-time stringidstringnamestringpermissionsarray of objects or null5 fields per item
allowedForCimdClientsbooleandescriptionstring or nullidstringkeystringnamestring
resourcestring
Delete API
Section titled “Delete API”/api/apis/{id}Delete an API by ID
Path parameters
idstringrequiredAPI ID
Response
List clients that can still be granted access to an API
Section titled “List clients that can still be granted access to an API”/api/apis/{id}/assignable-clientsGet a paginated list of OIDC clients that have no grant on the API yet
Path parameters
idstringrequiredAPI ID
Query parameters
searchstringSearch term to filter clients by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
clientType,createdAt,disabled,isGroupRestricted,name,pkceEnabled,pkceSupported,requiresPushedAuthorizationRequests,requiresReauthentication,skipConsentsort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[clientType]array of stringsOnly items whose clientType is one of these values
filters[disabled]array of booleansOnly items whose disabled is one of these values
filters[isGroupRestricted]array of booleansOnly items whose isGroupRestricted is one of these values
filters[pkceEnabled]array of booleansOnly items whose pkceEnabled is one of these values
filters[pkceSupported]array of booleansOnly items whose pkceSupported is one of these values
filters[requiresPushedAuthorizationRequests]array of booleansOnly items whose requiresPushedAuthorizationRequests is one of these values
filters[requiresReauthentication]array of booleansOnly items whose requiresReauthentication is one of these values
filters[skipConsent]array of booleansOnly items whose skipConsent is one of these values
Response
2 fields
dataarray of objects or null6 fields per item
clientTypestringhasDarkLogobooleanhasLogobooleanidstringisPublicbooleannamestring
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Update metadata document client access
Section titled “Update metadata document client access”/api/apis/{id}/cimd-accessReplace which permissions of an API every client registered through a Client ID Metadata Document may request
Path parameters
idstringrequiredAPI ID
Body application/json
enabledbooleanpermissionIdsarray of strings or null
Response
6 fields
allowCimdClientsbooleancreatedAtdate-time stringidstringnamestringpermissionsarray of objects or null5 fields per item
allowedForCimdClientsbooleandescriptionstring or nullidstringkeystringnamestring
resourcestring
List clients with access to an API
Section titled “List clients with access to an API”/api/apis/{id}/clientsGet a paginated list of OIDC clients that may reach the API, with their permissions split into user-delegated and client (machine-to-machine) access
Path parameters
idstringrequiredAPI ID
Query parameters
searchstringSearch term to filter clients by name
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
clientType,createdAt,disabled,isGroupRestricted,name,pkceEnabled,pkceSupported,requiresPushedAuthorizationRequests,requiresReauthentication,skipConsentsort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[clientType]array of stringsOnly items whose clientType is one of these values
filters[disabled]array of booleansOnly items whose disabled is one of these values
filters[isGroupRestricted]array of booleansOnly items whose isGroupRestricted is one of these values
filters[pkceEnabled]array of booleansOnly items whose pkceEnabled is one of these values
filters[pkceSupported]array of booleansOnly items whose pkceSupported is one of these values
filters[requiresPushedAuthorizationRequests]array of booleansOnly items whose requiresPushedAuthorizationRequests is one of these values
filters[requiresReauthentication]array of booleansOnly items whose requiresReauthentication is one of these values
filters[skipConsent]array of booleansOnly items whose skipConsent is one of these values
Response
2 fields
dataarray of objects or null7 fields per item
cimdGrantedAccessbooleancimdGrantedPermissionIdsarray of strings or nullclientobject6 fields
clientTypestringhasDarkLogobooleanhasLogobooleanidstringisPublicbooleannamestring
clientAccessbooleanclientPermissionIdsarray of strings or nulluserDelegatedAccessbooleanuserDelegatedPermissionIdsarray of strings or null
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Update a client's access to an API
Section titled “Update a client's access to an API”/api/apis/{id}/clients/{clientId}Replace the permissions of this API a single OIDC client may request, leaving its grants on other APIs untouched
Path parameters
idstringrequiredAPI ID
clientIdstringrequiredOIDC Client ID
Body application/json
clientAccessbooleanclientPermissionIdsarray of strings or nulluserDelegatedAccessbooleanuserDelegatedPermissionIdsarray of strings or null
Response
4 fields
clientAccessbooleanclientPermissionIdsarray of strings or nulluserDelegatedAccessbooleanuserDelegatedPermissionIdsarray of strings or null
Revoke a client's access to an API
Section titled “Revoke a client's access to an API”/api/apis/{id}/clients/{clientId}Remove every permission of this API a single OIDC client was allowed to request
Path parameters
idstringrequiredAPI ID
clientIdstringrequiredOIDC Client ID
Response
Update API permissions
Section titled “Update API permissions”/api/apis/{id}/permissionsReplace the full set of permissions for an API
Path parameters
idstringrequiredAPI ID
Body application/json
permissionsarray of objects or null3 fields per item
keystringrequired1 to 128 characters
namestringrequired1 to 50 characters
descriptionstring or nullat most 200 characters
Response
6 fields
allowCimdClientsbooleancreatedAtdate-time stringidstringnamestringpermissionsarray of objects or null5 fields per item
allowedForCimdClientsbooleandescriptionstring or nullidstringkeystringnamestring
resourcestring
Custom Claims
Section titled “Custom Claims”Extra claims that Pocket ID adds to the tokens of a user or of every member of a group.
- get
/api/custom-claims/suggestionsGet custom claim suggestions - put
/api/custom-claims/user-group/{userGroupId}Update custom claims for a user group - put
/api/custom-claims/user/{userId}Update custom claims for a user
Get custom claim suggestions
Section titled “Get custom claim suggestions”/api/custom-claims/suggestionsGet a list of suggested custom claim names
Response
Update custom claims for a user group
Section titled “Update custom claims for a user group”/api/custom-claims/user-group/{userGroupId}Update or create custom claims for a specific user group
Path parameters
userGroupIdstringrequiredUser Group ID
Body application/json
An array, with these fields per item:
keystringrequiredvaluestringrequired
Response
2 fields per item
keystringvaluestring
Update custom claims for a user
Section titled “Update custom claims for a user”/api/custom-claims/user/{userId}Update or create custom claims for a specific user
Path parameters
userIdstringrequiredUser ID
Body application/json
An array, with these fields per item:
keystringrequiredvaluestringrequired
Response
2 fields per item
keystringvaluestring
API Keys
Section titled “API Keys”Keys for this REST API.
- get
/api/api-keysList API keys - post
/api/api-keysCreate API key - put
/api/api-keys/{id}Update API key - patch
/api/api-keys/{id}Update API key - delete
/api/api-keys/{id}Revoke API key - post
/api/api-keys/{id}/renewRenew API key
List API keys
Section titled “List API keys”/api/api-keysGet a paginated list of API keys belonging to the current user
Query parameters
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
createdAt,expiresAt,lastUsedAt,namesort[direction]stringSort direction
One of
asc,desc· defaults toasc
Response
2 fields
dataarray of objects or null9 fields per item
createdAtdate-time stringdescriptionstring or nullexpirationEmailSentbooleanexpiresAtdate-time stringidstringlastUsedAtdate-time string or nullnamestringpreviousKeyExpiresAtdate-time string or nullscopesarray of strings or null
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
Create API key
Section titled “Create API key”/api/api-keysCreate a new API key for the current user
Body application/json
expiresAtdate-time stringrequirednamestringrequired3 to 50 characters
scopesarray of stringsrequiredat least 1 items
descriptionstring or null
Response
2 fields
apiKeyobject9 fields
createdAtdate-time stringdescriptionstring or nullexpirationEmailSentbooleanexpiresAtdate-time stringidstringlastUsedAtdate-time string or nullnamestringpreviousKeyExpiresAtdate-time string or nullscopesarray of strings or null
tokenstring
Update API key
Section titled “Update API key”/api/api-keys/{id}Change the name, description and scopes of an existing API key, where PATCH changes only the fields in the body; its token stays the same
Path parameters
idstringrequiredAPI Key ID
Body application/json
namestringrequired3 to 50 characters
scopesarray of stringsrequiredat least 1 items
descriptionstring or null
Response
9 fields
createdAtdate-time stringdescriptionstring or nullexpirationEmailSentbooleanexpiresAtdate-time stringidstringlastUsedAtdate-time string or nullnamestringpreviousKeyExpiresAtdate-time string or nullscopesarray of strings or null
Update API key
Section titled “Update API key”/api/api-keys/{id}Change the name, description and scopes of an existing API key, where PATCH changes only the fields in the body; its token stays the same
Path parameters
idstringrequiredAPI Key ID
Body application/json, application/merge-patch+json
descriptionstring or nullnamestring3 to 50 characters
scopesarray of stringsat least 1 items
Response
9 fields
createdAtdate-time stringdescriptionstring or nullexpirationEmailSentbooleanexpiresAtdate-time stringidstringlastUsedAtdate-time string or nullnamestringpreviousKeyExpiresAtdate-time string or nullscopesarray of strings or null
Revoke API key
Section titled “Revoke API key”/api/api-keys/{id}Revoke (delete) an existing API key by ID
Path parameters
idstringrequiredAPI Key ID
Response
Renew API key
Section titled “Renew API key”/api/api-keys/{id}/renewWhile a key has not expired, its old token keeps working for the given grace period, but never past the key's previous expiration
Path parameters
idstringrequiredAPI Key ID
Body application/json
expiresAtdate-time stringrequiredgracePeriodHoursintegerat least 0
Response
2 fields
apiKeyobject9 fields
createdAtdate-time stringdescriptionstring or nullexpirationEmailSentbooleanexpiresAtdate-time stringidstringlastUsedAtdate-time string or nullnamestringpreviousKeyExpiresAtdate-time string or nullscopesarray of strings or null
tokenstring
Sessions
Section titled “Sessions”The sign-in sessions of the current user or of any user.
- get
/api/sessionsList own sessions - delete
/api/sessionsRevoke other own sessions - post
/api/sessions/current/rememberRemember current session - delete
/api/sessions/{id}Revoke own session - get
/api/users/{id}/sessionsList sessions of a user - delete
/api/users/{id}/sessionsRevoke all sessions of a user - delete
/api/users/{id}/sessions/{sessionId}Revoke a session of a user
List own sessions
Section titled “List own sessions”/api/sessionsGet the browsers in which the current user is signed in, most recently active first
Response
13 fields per item
authenticationMethodstringbrowserstringcitystringcountrystringcreatedAtdate-time stringcurrentbooleandeviceTypestringexpiresAtdate-time stringidstringipAddressstringlastActiveAtdate-time stringosstringuserAgentstring
Revoke other own sessions
Section titled “Revoke other own sessions”/api/sessionsSign the current user out of every session except the current one
Response
Remember current session
Section titled “Remember current session”/api/sessions/current/rememberKeep the current session signed in after the browser closes and while it goes unused, for a sign-in that was not remembered
Response
Revoke own session
Section titled “Revoke own session”/api/sessions/{id}Sign the current user out of one of their sessions
Path parameters
idstringrequiredSession ID
Response
List sessions of a user
Section titled “List sessions of a user”/api/users/{id}/sessionsGet the browsers in which a user is signed in, most recently active first
Path parameters
idstringrequiredUser ID
Response
13 fields per item
authenticationMethodstringbrowserstringcitystringcountrystringcreatedAtdate-time stringcurrentbooleandeviceTypestringexpiresAtdate-time stringidstringipAddressstringlastActiveAtdate-time stringosstringuserAgentstring
Revoke all sessions of a user
Section titled “Revoke all sessions of a user”/api/users/{id}/sessionsSign a user out of every session and revoke every grant their apps hold, offline_access ones included
Path parameters
idstringrequiredUser ID
Response
Revoke a session of a user
Section titled “Revoke a session of a user”/api/users/{id}/sessions/{sessionId}Sign a user out of one of their sessions
Path parameters
idstringrequiredUser ID
sessionIdstringrequiredSession ID
Response
Application Configuration
Section titled “Application Configuration”The settings of the Application Configuration page, the LDAP sync and the test email.
- get
/api/application-configurationList public application configurations - put
/api/application-configurationUpdate application configurations - patch
/api/application-configurationUpdate application configurations - get
/api/application-configuration/allList all application configurations - post
/api/application-configuration/sync-ldapSynchronize LDAP - post
/api/application-configuration/test-emailSend test email
List public application configurations
Section titled “List public application configurations”/api/application-configurationGet all public application configurations
Response
3 fields per item
keystringtypestringvaluestring
Update application configurations
Section titled “Update application configurations”/api/application-configurationUpdate application configuration settings, where PATCH changes only the fields in the body
Body application/json
allowOwnAccountEditstringrequiredallowUserSignupsstringrequiredOne of
disabled,withToken,openappNamestringrequired1 to 30 characters
autoCreateOidcClientSecretstringrequiredemailApiKeyExpirationEnabledstringrequiredemailLoginNotificationModestringrequiredOne of
disabled,always,ipAndUserAgent,browserRecognitionemailOneTimeAccessAsAdminEnabledstringrequiredemailOneTimeAccessAsUnauthenticatedEnabledstringrequiredemailVerificationstringrequiredOne of
disabled,optional,requiredemailsVerifiedstringrequiredhomePageUrlstringrequiredldapEnabledstringrequiredldapSkipCertVerifystringrequiredldapSoftDeleteUsersstringrequiredrequireUserEmailstringrequiredsessionDurationstringrequiredsmtpSkipCertVerifystringrequiredsmtpTlsstringrequiredOne of
none,starttls,tlswebauthnAllowSyncedPasskeysstringrequiredwebauthnAuthenticatorAttachmentstringrequiredOne of
any,platform,cross-platformwebauthnUserVerificationstringrequiredOne of
required,preferredappearancestringcimdUrlAllowliststringenabledFeaturesstringldapAdminGroupNamestringldapAttributeGroupMemberstringldapAttributeGroupNamestringldapAttributeGroupUniqueIdentifierstringldapAttributeUserDisplayNamestringldapAttributeUserEmailstringldapAttributeUserFirstNamestringldapAttributeUserLastNamestringldapAttributeUserProfilePicturestringldapAttributeUserUniqueIdentifierstringldapAttributeUserUsernamestringldapBasestringldapBindDnstringldapBindPasswordstringldapUrlstringldapUserGroupSearchFilterstringldapUserSearchFilterstringsignupDefaultCustomClaimsstringsignupDefaultUserGroupIDsstringsmtpFromstringsmtpHoststringsmtpPasswordstringsmtpPortstringsmtpUserstring
Response
5 fields per item
envOverridebooleanisPublicbooleankeystringtypestringvaluestring
Update application configurations
Section titled “Update application configurations”/api/application-configurationUpdate application configuration settings, where PATCH changes only the fields in the body
Body application/json, application/merge-patch+json
allowOwnAccountEditstringallowUserSignupsstringOne of
disabled,withToken,openappNamestring1 to 30 characters
appearancestringautoCreateOidcClientSecretstringcimdUrlAllowliststringemailApiKeyExpirationEnabledstringemailLoginNotificationModestringOne of
disabled,always,ipAndUserAgent,browserRecognitionemailOneTimeAccessAsAdminEnabledstringemailOneTimeAccessAsUnauthenticatedEnabledstringemailVerificationstringOne of
disabled,optional,requiredemailsVerifiedstringenabledFeaturesstringhomePageUrlstringldapAdminGroupNamestringldapAttributeGroupMemberstringldapAttributeGroupNamestringldapAttributeGroupUniqueIdentifierstringldapAttributeUserDisplayNamestringldapAttributeUserEmailstringldapAttributeUserFirstNamestringldapAttributeUserLastNamestringldapAttributeUserProfilePicturestringldapAttributeUserUniqueIdentifierstringldapAttributeUserUsernamestringldapBasestringldapBindDnstringldapBindPasswordstringldapEnabledstringldapSkipCertVerifystringldapSoftDeleteUsersstringldapUrlstringldapUserGroupSearchFilterstringldapUserSearchFilterstringrequireUserEmailstringsessionDurationstringsignupDefaultCustomClaimsstringsignupDefaultUserGroupIDsstringsmtpFromstringsmtpHoststringsmtpPasswordstringsmtpPortstringsmtpSkipCertVerifystringsmtpTlsstringOne of
none,starttls,tlssmtpUserstringwebauthnAllowSyncedPasskeysstringwebauthnAuthenticatorAttachmentstringOne of
any,platform,cross-platformwebauthnUserVerificationstringOne of
required,preferred
Response
5 fields per item
envOverridebooleanisPublicbooleankeystringtypestringvaluestring
List all application configurations
Section titled “List all application configurations”/api/application-configuration/allGet all application configurations including private ones
Response
5 fields per item
envOverridebooleanisPublicbooleankeystringtypestringvaluestring
Synchronize LDAP
Section titled “Synchronize LDAP”/api/application-configuration/sync-ldapManually trigger LDAP synchronization
Response
Send test email
Section titled “Send test email”/api/application-configuration/test-emailSend a test email to verify email configuration
Response
Application Assets
Section titled “Application Assets”The logo, favicon, background, font, email logo and default profile picture.
- get
/api/application-assets/backgroundGet background image - put
/api/application-assets/backgroundUpdate background image - delete
/api/application-assets/backgroundDelete background image - get
/api/application-assets/default-profile-pictureGet default profile picture image - put
/api/application-assets/default-profile-pictureUpdate default profile picture image - delete
/api/application-assets/default-profile-pictureDelete default profile picture image - get
/api/application-assets/emailGet email logo image - put
/api/application-assets/emailUpdate email logo - get
/api/application-assets/faviconGet favicon - put
/api/application-assets/faviconUpdate favicon - get
/api/application-assets/fontGet title font - put
/api/application-assets/fontUpdate title font - delete
/api/application-assets/fontDelete title font - get
/api/application-assets/logoGet logo image - put
/api/application-assets/logoUpdate logo - delete
/api/application-assets/logoDelete logo image
Get background image
Section titled “Get background image”/api/application-assets/backgroundGet the background image for the application
Query parameters
defaultbooleanReturn the bundled default if no custom one is set
defaults to
true
Response
Update background image
Section titled “Update background image”/api/application-assets/backgroundUpdate the application background image
Body multipart/form-data
filebinaryrequiredBackground image file
Response
Delete background image
Section titled “Delete background image”/api/application-assets/backgroundDelete the application background image
Response
Get default profile picture image
Section titled “Get default profile picture image”/api/application-assets/default-profile-pictureGet the default profile picture image for the application
Query parameters
defaultbooleanReturn the bundled default if no custom one is set
defaults to
true
Response
Update default profile picture image
Section titled “Update default profile picture image”/api/application-assets/default-profile-pictureUpdate the default profile picture image
Body multipart/form-data
filebinaryrequiredProfile picture image file
Response
Delete default profile picture image
Section titled “Delete default profile picture image”/api/application-assets/default-profile-pictureDelete the default profile picture image
Response
Get email logo image
Section titled “Get email logo image”/api/application-assets/emailGet the email logo image for use in emails
Query parameters
defaultbooleanReturn the bundled default if no custom one is set
defaults to
true
Response
Update email logo
Section titled “Update email logo”/api/application-assets/emailUpdate the email logo for use in emails
Body multipart/form-data
filebinaryrequiredEmail logo image file
Response
Get favicon
Section titled “Get favicon”/api/application-assets/faviconGet the favicon for the application
Query parameters
defaultbooleanReturn the bundled default if no custom one is set
defaults to
true
Response
Update favicon
Section titled “Update favicon”/api/application-assets/faviconUpdate the application favicon
Body multipart/form-data
filebinaryrequiredFavicon file (.svg/.png/.ico)
Response
Get title font
Section titled “Get title font”/api/application-assets/fontGet the custom font of page and dialog titles
Query parameters
defaultbooleanReturn the bundled default if no custom one is set
defaults to
true
Response
Update title font
Section titled “Update title font”/api/application-assets/fontUpdate the custom font of page and dialog titles
Body multipart/form-data
filebinaryrequiredFont file (.woff2/.woff/.ttf/.otf)
Response
Delete title font
Section titled “Delete title font”/api/application-assets/fontDelete the custom font of page and dialog titles
Response
Get logo image
Section titled “Get logo image”/api/application-assets/logoGet the logo image for the application
Query parameters
lightbooleanLight mode logo (true) or dark mode logo (false)
defaults to
truedefaultbooleanReturn the bundled default if no custom one is set
defaults to
true
Response
Update logo
Section titled “Update logo”/api/application-assets/logoUpdate the application logo
Query parameters
lightbooleanLight mode logo (true) or dark mode logo (false)
defaults to
true
Body multipart/form-data
filebinaryrequiredLogo image file
Response
Delete logo image
Section titled “Delete logo image”/api/application-assets/logoDelete the custom application logo and restore the default logo
Query parameters
lightbooleanLight mode logo (true) or dark mode logo (false)
defaults to
true
Response
Features
Section titled “Features”The optional features and whether they are on.
List optional features
Section titled “List optional features”/api/featuresGet whether each optional feature is on and whether anything uses it; a feature in use is always on
Response
Audit Logs
Section titled “Audit Logs”Sign-ins and other security events, of the current user or of everyone.
- get
/api/audit-logsList audit logs - get
/api/audit-logs/allList all audit logs - get
/api/audit-logs/filters/client-namesList client names - get
/api/audit-logs/filters/usersList users with IDs
List audit logs
Section titled “List audit logs”/api/audit-logsGet a paginated list of the audit logs about the current user
Query parameters
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
city,country,createdAt,event,ipAddress,userAgentsort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[event]array of stringsOnly items whose event is one of these values
fromstringOnly entries created at or after this RFC 3339 time
tostringOnly entries created before this RFC 3339 time
Response
2 fields
dataarray of objects or null13 fields per item
actorIDstringactorNamestringactorTypestringcitystringcountrystringcreatedAtdate-time stringdatamap of strings or nulldevicestringeventstringidstringipAddressstringuserIDstringusernamestring
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
List all audit logs
Section titled “List all audit logs”/api/audit-logs/allGet a paginated list of all audit logs (admin only)
Query parameters
pagination[page]integerPage number for pagination
defaults to
1pagination[limit]integerNumber of items per page
defaults to
20sort[column]stringColumn to sort by
One of
city,country,createdAt,event,ipAddress,userAgentsort[direction]stringSort direction
One of
asc,desc· defaults toascfilters[event]array of stringsOnly items whose event is one of these values
fromstringOnly entries created at or after this RFC 3339 time
tostringOnly entries created before this RFC 3339 time
filters[userID]stringOnly entries of this user, including the actions they took
filters[clientName]array of stringsOnly entries of the OIDC clients with these names
filters[location]array of stringsOnly entries from the internal or external network
Response
2 fields
dataarray of objects or null13 fields per item
actorIDstringactorNamestringactorTypestringcitystringcountrystringcreatedAtdate-time stringdatamap of strings or nulldevicestringeventstringidstringipAddressstringuserIDstringusernamestring
paginationobject4 fields
currentPageintegeritemsPerPageintegertotalItemsintegertotalPagesinteger
List client names
Section titled “List client names”/api/audit-logs/filters/client-namesGet a list of all client names for audit log filtering
Response
List users with IDs
Section titled “List users with IDs”/api/audit-logs/filters/usersGet a list of all usernames with their IDs for audit log filtering
Response
SCIM provisioning of an OIDC client.
- post
/api/scim/service-providerCreate SCIM service provider - put
/api/scim/service-provider/{id}Update SCIM service provider - patch
/api/scim/service-provider/{id}Update SCIM service provider - delete
/api/scim/service-provider/{id}Delete SCIM service provider - post
/api/scim/service-provider/{id}/syncSync SCIM service provider
Create SCIM service provider
Section titled “Create SCIM service provider”/api/scim/service-providerCreate a new SCIM service provider
Body application/json
endpointstringrequiredoidcClientIdstringrequiredtokenstring or null
Response
5 fields
createdAtdate-time stringendpointstringhasTokenbooleanidstringlastSyncedAtdate-time string or null
Update SCIM service provider
Section titled “Update SCIM service provider”/api/scim/service-provider/{id}Update an existing SCIM service provider, where PATCH changes only the fields in the body, an omitted token keeps the stored one, an empty token removes it and a changed endpoint requires the token
Path parameters
idstringrequiredService Provider ID
Body application/json
endpointstringrequiredoidcClientIdstringrequiredtokenstring or null
Response
5 fields
createdAtdate-time stringendpointstringhasTokenbooleanidstringlastSyncedAtdate-time string or null
Update SCIM service provider
Section titled “Update SCIM service provider”/api/scim/service-provider/{id}Update an existing SCIM service provider, where PATCH changes only the fields in the body, an omitted token keeps the stored one, an empty token removes it and a changed endpoint requires the token
Path parameters
idstringrequiredService Provider ID
Body application/json, application/merge-patch+json
endpointstringoidcClientIdstringtokenstring or null
Response
5 fields
createdAtdate-time stringendpointstringhasTokenbooleanidstringlastSyncedAtdate-time string or null
Delete SCIM service provider
Section titled “Delete SCIM service provider”/api/scim/service-provider/{id}Delete a SCIM service provider by ID
Path parameters
idstringrequiredService Provider ID
Response
Sync SCIM service provider
Section titled “Sync SCIM service provider”/api/scim/service-provider/{id}/syncTrigger synchronization for a SCIM service provider
Path parameters
idstringrequiredService Provider ID
Response
Device Login
Section titled “Device Login”The requests behind sign-in with another device.
- post
/api/device-login/requestsCreate device login request - post
/api/device-login/requests/{id}/exchangeExchange device login request - post
/api/device-login/verificationInspect device login request - post
/api/device-login/verification/decisionDecide device login request
Create device login request
Section titled “Create device login request”/api/device-login/requestsCreate a short-lived request that can be approved from another authenticated device
Response
6 fields
expiresAtdate-time stringidstringintervalintegeruserCodestringverificationUristringverificationUriCompletestring
Exchange device login request
Section titled “Exchange device login request”/api/device-login/requests/{id}/exchangeWait for a device login decision and create a browser session after it has been approved
Path parameters
idstringrequiredDevice login request ID
Query parameters
rememberbooleanSet to false for a session that ends when the browser closes or after 20 minutes without activity
defaults to
true
Responses
14 fields
customClaimsarray of objects or null2 fields per item
keystringvaluestring
disabledbooleandisplayNamestringemailstring or nullemailVerificationDeadlinedate-time string or nullemailVerifiedbooleanfirstNamestringidstringisAdminbooleanlastNamestring or nullldapIdstring or nulllocalestring or nulluserGroupsarray of objects or null7 fields per item
createdAtdate-time stringcustomClaimsarray of objects or null2 fields per item
keystringvaluestring
friendlyNamestringidstringldapIdstring or nullnamestringuserCountinteger
usernamestring
Inspect device login request
Section titled “Inspect device login request”/api/device-login/verificationRetrieve the requesting device details for an authenticated user before approval or denial
Body application/json
codestringrequired
Response
6 fields
citystringcountrystringdevicestringexpiresAtdate-time stringipAddressstringuserCodestring
Decide device login request
Section titled “Decide device login request”/api/device-login/verification/decisionApprove or deny a device login request; approval requires fresh passkey reauthentication
Body application/json
codestringrequireddecisionstringrequiredOne of
approve,deny
Response
Well Known
Section titled “Well Known”Discovery documents and signing keys, which OIDC clients read without authentication.
- get
/.well-known/jwks.jsonGet JSON Web Key Set (JWKS) - get
/.well-known/oauth-authorization-serverGet OAuth 2.0 authorization server metadata - get
/.well-known/oauth-protected-resource/mcpGet OAuth 2.0 protected resource metadata of the MCP endpoint - get
/.well-known/openid-configurationGet OpenID Connect discovery configuration
Get JSON Web Key Set (JWKS)
Section titled “Get JSON Web Key Set (JWKS)”/.well-known/jwks.jsonReturns the JSON Web Key Set used for token verification
Response
Get OAuth 2.0 authorization server metadata
Section titled “Get OAuth 2.0 authorization server metadata”/.well-known/oauth-authorization-serverReturns the RFC 8414 OAuth 2.0 authorization server metadata document with endpoints and capabilities
Response
Get OAuth 2.0 protected resource metadata of the MCP endpoint
Section titled “Get OAuth 2.0 protected resource metadata of the MCP endpoint”/.well-known/oauth-protected-resource/mcpReturns the RFC 9728 protected resource metadata of Pocket ID's MCP endpoint, which MCP clients use to find the authorization server and the scopes they can request
Response
Get OpenID Connect discovery configuration
Section titled “Get OpenID Connect discovery configuration”/.well-known/openid-configurationReturns the OpenID Connect discovery document with endpoints and capabilities
Response
Version
Section titled “Version”The running version and the latest release.
- get
/api/version/currentGet current deployed version of Pocket ID - get
/api/version/latestGet latest available version of Pocket ID
Get current deployed version of Pocket ID
Section titled “Get current deployed version of Pocket ID”/api/version/currentResponse
1 field
currentVersionstring
Get latest available version of Pocket ID
Section titled “Get latest available version of Pocket ID”/api/version/latestResponse
1 field
latestVersionstring
Health
Section titled “Health”A health check for container orchestrators and load balancers.
Responds to healthchecks
Section titled “Responds to healthchecks”/healthzResponds with a successful status code to healthcheck requests
Response
Storage
Section titled “Storage”Storage warnings for the admin UI.
Get whether the SQLite storage warning should be shown
Section titled “Get whether the SQLite storage warning should be shown”/api/storage/sqlite-warningReports whether Pocket ID found its SQLite database on a networked filesystem, which is unsupported and can lead to database corruption
Response
1 field
showWarningboolean