Skip to content
v2.19.3GitHub

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-email

Request a one-time access email for unauthenticated users

Body application/json

  • emailstringrequired
  • redirectPathstring

Response

204 No Content
post/api/one-time-access-token

Exchange a one-time access token for a session token

Query parameters

  • rememberboolean

    Set 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

200 OKapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
post/api/signup

Create a new user account

Body application/json

  • usernamestringrequired

    1 to 50 characters

  • emailstring or null
  • firstNamestring

    at most 50 characters

  • lastNamestring

    at most 50 characters

  • tokenstring

Response

201 Createdapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
get/api/signup-tokens

Get a paginated list of signup tokens

Query parameters

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of createdAt, expiresAt, usageCount, usageLimit

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • expiresAtdate-time string
    • idstring
    • tokenstring
    • usageCountinteger
    • usageLimitinteger
    • userGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
post/api/signup-tokens

Create a new signup token that allows user registration

Body application/json

  • ttlstringrequired

    A duration such as 15m or 24h, or a number of seconds

  • usageLimitintegerrequired

    1 to 100

  • userGroupIdsarray of strings or null

Response

201 Createdapplication/json
7 fields
  • createdAtdate-time string
  • expiresAtdate-time string
  • idstring
  • tokenstring
  • usageCountinteger
  • usageLimitinteger
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
delete/api/signup-tokens/{id}

Delete a signup token by ID

Path parameters

  • idstringrequired

    Token ID

Response

204 No Content
get/api/signup/setup

Succeeds while no admin has been set up yet and fails with setup_not_available afterwards

Response

204 No Content
post/api/signup/setup

Sign up and generate setup access token for initial admin user

Body application/json

  • usernamestringrequired

    1 to 50 characters

  • emailstring or null
  • firstNamestring

    at most 50 characters

  • lastNamestring

    at most 50 characters

  • tokenstring

Response

200 OKapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
get/api/users

Get a paginated list of users with optional search and sorting

Query parameters

  • searchstring

    Search term to filter users

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of createdAt, disabled, displayName, email, emailVerified, firstName, isAdmin, lastName, username

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[disabled]array of booleans

    Only items whose disabled is one of these values

  • filters[emailVerified]array of booleans

    Only items whose emailVerified is one of these values

  • filters[isAdmin]array of booleans

    Only items whose isAdmin is one of these values

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    14 fields per item
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • disabledboolean
    • displayNamestring
    • emailstring or null
    • emailVerificationDeadlinedate-time string or null
    • emailVerifiedboolean
    • firstNamestring
    • idstring
    • isAdminboolean
    • lastNamestring or null
    • ldapIdstring or null
    • localestring or null
    • userGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
    • usernamestring
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
post/api/users

Create a new user

Body application/json

  • usernamestringrequired

    1 to 50 characters

  • disabledboolean
  • displayNamestring

    at most 100 characters

  • emailstring or null
  • emailVerifiedboolean
  • firstNamestring

    at most 50 characters

  • idstring
  • isAdminboolean
  • lastNamestring

    at most 50 characters

  • localestring or null
  • userGroupIdsarray of strings or null

Response

201 Createdapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
get/api/users/me

Retrieve information about the currently authenticated user

Response

200 OKapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
put/api/users/me

Update the currently authenticated user's information, where PATCH changes only the fields in the body

Body application/json

  • usernamestringrequired

    1 to 50 characters

  • disabledboolean
  • displayNamestring

    at most 100 characters

  • emailstring or null
  • emailVerifiedboolean
  • firstNamestring

    at most 50 characters

  • idstring
  • isAdminboolean
  • lastNamestring

    at most 50 characters

  • localestring or null
  • userGroupIdsarray of strings or null

Response

200 OKapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
patch/api/users/me

Update the currently authenticated user's information, where PATCH changes only the fields in the body

Body application/json, application/merge-patch+json

  • disabledboolean
  • displayNamestring

    at most 100 characters

  • emailstring or null
  • emailVerifiedboolean
  • firstNamestring

    at most 50 characters

  • idstring
  • isAdminboolean
  • lastNamestring

    at most 50 characters

  • localestring or null
  • userGroupIdsarray of strings or null
  • usernamestring

    1 to 50 characters

Response

200 OKapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
get/api/users/me/email-change

Get the email change of the currently authenticated user that still has to be confirmed through the emailed link

Responses

200 OKapplication/json
2 fields
  • emailstring
  • expiresAtdate-time string
204 No pending email change
delete/api/users/me/email-change

Cancel the pending email change of the currently authenticated user, so its verification link stops working

Response

204 No Content
put/api/users/me/profile-picture

Update the currently authenticated user's profile picture

Body multipart/form-data

  • filebinaryrequired

    Profile picture image file (PNG, JPG, or JPEG)

Response

204 No Content
delete/api/users/me/profile-picture

Reset the currently authenticated user's profile picture to the default

Response

204 No Content
post/api/users/me/send-email-verification

Send an email verification to the currently authenticated user

Response

204 No Content
post/api/users/me/verify-email

Verify the currently authenticated user's email using a verification token

Body application/json

  • tokenstringrequired

Response

204 No Content
get/api/users/{id}

Retrieve detailed information about a specific user

Path parameters

  • idstringrequired

    User ID

Response

200 OKapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
put/api/users/{id}

Update an existing user by ID, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    User ID

Body application/json

  • usernamestringrequired

    1 to 50 characters

  • disabledboolean
  • displayNamestring

    at most 100 characters

  • emailstring or null
  • emailVerifiedboolean
  • firstNamestring

    at most 50 characters

  • idstring
  • isAdminboolean
  • lastNamestring

    at most 50 characters

  • localestring or null
  • userGroupIdsarray of strings or null

Response

200 OKapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
patch/api/users/{id}

Update an existing user by ID, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    User ID

Body application/json, application/merge-patch+json

  • disabledboolean
  • displayNamestring

    at most 100 characters

  • emailstring or null
  • emailVerifiedboolean
  • firstNamestring

    at most 50 characters

  • idstring
  • isAdminboolean
  • lastNamestring

    at most 50 characters

  • localestring or null
  • userGroupIdsarray of strings or null
  • usernamestring

    1 to 50 characters

Response

200 OKapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
delete/api/users/{id}

Delete a specific user by ID

Path parameters

  • idstringrequired

    User ID

Response

204 No Content
get/api/users/{id}/groups

Retrieve all groups a specific user belongs to

Path parameters

  • idstringrequired

    User ID

Response

200 OKapplication/json
8 fields per item
  • allowedOidcClientsarray of objects or null
    8 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • createdAtdate-time string
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • friendlyNamestring
  • idstring
  • ldapIdstring or null
  • namestring
  • usersarray of objects or null
    14 fields per item
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • disabledboolean
    • displayNamestring
    • emailstring or null
    • emailVerificationDeadlinedate-time string or null
    • emailVerifiedboolean
    • firstNamestring
    • idstring
    • isAdminboolean
    • lastNamestring or null
    • ldapIdstring or null
    • localestring or null
    • userGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
    • usernamestring
post/api/users/{id}/one-time-access-email

Request a one-time access email for a specific user (admin only)

Path parameters

  • idstringrequired

    User ID

Body application/json

  • ttlstring

    A duration such as 15m or 24h, or a number of seconds

Response

204 No Content

Create one-time access token for user (admin)

Section titled “Create one-time access token for user (admin)”
post/api/users/{id}/one-time-access-token

Generate a one-time access token for a specific user (admin only)

Path parameters

  • idstringrequired

    User ID

Body application/json

  • ttlstring

    A duration such as 15m or 24h, or a number of seconds

Response

201 Createdapplication/json
1 field
  • tokenstring
put/api/users/{id}/profile-picture

Update a specific user's profile picture

Path parameters

  • idstringrequired

    User ID

Body multipart/form-data

  • filebinaryrequired

    Profile picture image file (PNG, JPG, or JPEG)

Response

204 No Content
delete/api/users/{id}/profile-picture

Reset a specific user's profile picture to the default

Path parameters

  • idstringrequired

    User ID

Response

204 No Content
get/api/users/{id}/profile-picture.png

Retrieve a specific user's profile picture

Path parameters

  • idstringrequired

    User ID

Response

200 PNG imageimage/png
put/api/users/{id}/user-groups

Update the groups a specific user belongs to

Path parameters

  • idstringrequired

    User ID

Body application/json

  • userGroupIdsarray of stringsrequired

Response

200 OKapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
get/api/users/{id}/webauthn-credentials

Retrieve all WebAuthn credentials for a specific user

Path parameters

  • idstringrequired

    User ID

Response

200 OKapplication/json
10 fields per item
  • aaguidstring
  • attestationTypestring
  • backupEligibleboolean
  • backupStateboolean
  • createdAtdate-time string
  • credentialIDstring
  • hasIconboolean
  • idstring
  • namestring
  • transportarray of strings or null
delete/api/users/{id}/webauthn-credentials/{credentialId}

Delete a specific WebAuthn credential for a user

Path parameters

  • idstringrequired

    User ID

  • credentialIdstringrequired

    Credential ID

Response

204 No Content

Groups and their members.

get/api/user-groups

Get a paginated list of user groups with optional search and sorting

Query parameters

  • searchstring

    Search term to filter user groups by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of createdAt, friendlyName, name, userCount

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
post/api/user-groups

Create a new user group

Body application/json

  • friendlyNamestringrequired

    2 to 50 characters

  • namestringrequired

    2 to 255 characters

Response

201 Createdapplication/json
8 fields
  • allowedOidcClientsarray of objects or null
    8 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • createdAtdate-time string
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • friendlyNamestring
  • idstring
  • ldapIdstring or null
  • namestring
  • usersarray of objects or null
    14 fields per item
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • disabledboolean
    • displayNamestring
    • emailstring or null
    • emailVerificationDeadlinedate-time string or null
    • emailVerifiedboolean
    • firstNamestring
    • idstring
    • isAdminboolean
    • lastNamestring or null
    • ldapIdstring or null
    • localestring or null
    • userGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
    • usernamestring
get/api/user-groups/{id}

Retrieve detailed information about a specific user group including its users

Path parameters

  • idstringrequired

    User Group ID

Response

200 OKapplication/json
8 fields
  • allowedOidcClientsarray of objects or null
    8 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • createdAtdate-time string
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • friendlyNamestring
  • idstring
  • ldapIdstring or null
  • namestring
  • usersarray of objects or null
    14 fields per item
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • disabledboolean
    • displayNamestring
    • emailstring or null
    • emailVerificationDeadlinedate-time string or null
    • emailVerifiedboolean
    • firstNamestring
    • idstring
    • isAdminboolean
    • lastNamestring or null
    • ldapIdstring or null
    • localestring or null
    • userGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
    • usernamestring
put/api/user-groups/{id}

Update an existing user group by ID, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    User Group ID

Body application/json

  • friendlyNamestringrequired

    2 to 50 characters

  • namestringrequired

    2 to 255 characters

Response

200 OKapplication/json
8 fields
  • allowedOidcClientsarray of objects or null
    8 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • createdAtdate-time string
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • friendlyNamestring
  • idstring
  • ldapIdstring or null
  • namestring
  • usersarray of objects or null
    14 fields per item
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • disabledboolean
    • displayNamestring
    • emailstring or null
    • emailVerificationDeadlinedate-time string or null
    • emailVerifiedboolean
    • firstNamestring
    • idstring
    • isAdminboolean
    • lastNamestring or null
    • ldapIdstring or null
    • localestring or null
    • userGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
    • usernamestring
patch/api/user-groups/{id}

Update an existing user group by ID, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    User Group ID

Body application/json, application/merge-patch+json

  • friendlyNamestring

    2 to 50 characters

  • namestring

    2 to 255 characters

Response

200 OKapplication/json
8 fields
  • allowedOidcClientsarray of objects or null
    8 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • createdAtdate-time string
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • friendlyNamestring
  • idstring
  • ldapIdstring or null
  • namestring
  • usersarray of objects or null
    14 fields per item
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • disabledboolean
    • displayNamestring
    • emailstring or null
    • emailVerificationDeadlinedate-time string or null
    • emailVerifiedboolean
    • firstNamestring
    • idstring
    • isAdminboolean
    • lastNamestring or null
    • ldapIdstring or null
    • localestring or null
    • userGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
    • usernamestring
delete/api/user-groups/{id}

Delete a specific user group by ID

Path parameters

  • idstringrequired

    User Group ID

Response

204 No Content
put/api/user-groups/{id}/users

Update the list of users belonging to a specific user group

Path parameters

  • idstringrequired

    User Group ID

Body application/json

  • userIdsarray of stringsrequired

Response

200 OKapplication/json
8 fields
  • allowedOidcClientsarray of objects or null
    8 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • createdAtdate-time string
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • friendlyNamestring
  • idstring
  • ldapIdstring or null
  • namestring
  • usersarray of objects or null
    14 fields per item
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • disabledboolean
    • displayNamestring
    • emailstring or null
    • emailVerificationDeadlinedate-time string or null
    • emailVerifiedboolean
    • firstNamestring
    • idstring
    • isAdminboolean
    • lastNamestring or null
    • ldapIdstring or null
    • localestring or null
    • userGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
    • usernamestring

OIDC clients with their secrets, logos and allowed groups, plus the clients each user has authorized.

get/api/oidc/clients

Get a paginated list of OIDC clients with optional search and sorting

Query parameters

  • searchstring

    Search term to filter clients by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of allowedUserGroups, clientType, createdAt, disabled, isGroupRestricted, name, pkceEnabled, pkceSupported, requiresPushedAuthorizationRequests, requiresReauthentication, skipConsent

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[clientType]array of strings

    Only items whose clientType is one of these values

  • filters[disabled]array of booleans

    Only items whose disabled is one of these values

  • filters[isGroupRestricted]array of booleans

    Only items whose isGroupRestricted is one of these values

  • filters[pkceEnabled]array of booleans

    Only items whose pkceEnabled is one of these values

  • filters[pkceSupported]array of booleans

    Only items whose pkceSupported is one of these values

  • filters[requiresPushedAuthorizationRequests]array of booleans

    Only items whose requiresPushedAuthorizationRequests is one of these values

  • filters[requiresReauthentication]array of booleans

    Only items whose requiresReauthentication is one of these values

  • filters[skipConsent]array of booleans

    Only items whose skipConsent is one of these values

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    23 fields per item
    • accessTokenDurationMinutesinteger
    • allowedUserGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
    • backchannelLogoutURLstring
    • callbackURLsarray of strings or null
    • claimMappingPolicyIdstring
    • clientTypestring
    • credentialsobject
      2 fields
      • federatedIdentitiesarray of objects or null
        6 fields per item
        • audiencestring
        • issuerstring
        • jwksstring
        • publicKeysarray of values or null
        • replayProtectionboolean
        • subjectstring
      • secretsarray of objects or null
        5 fields per item
        • createdAtdate-time string
        • expiresAtdate-time string or null
        • idstring
        • isActiveboolean
        • prefixstring
    • descriptionstring
    • disabledboolean
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • isGroupRestrictedboolean
    • isPublicboolean
    • launchURLstring or null
    • logoutCallbackURLsarray of strings or null
    • namestring
    • pkceEnabledboolean
    • pkceSupportedboolean
    • refreshTokenDurationMinutesinteger
    • requiresPushedAuthorizationRequestsboolean
    • requiresReauthenticationboolean
    • skipConsentboolean
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
post/api/oidc/clients

Create a new OIDC client

Body application/json

  • namestringrequired

    at most 50 characters

  • accessTokenDurationMinutesinteger
  • backchannelLogoutURLstring
  • callbackURLsarray of strings or null
  • claimMappingPolicyIdstring
  • credentialsobject
    2 fields
    • federatedIdentitiesarray of objects or null
      6 fields per item
      • audiencestring
      • issuerstring
      • jwksstring
      • publicKeysarray of values or null
      • replayProtectionboolean
      • subjectstring
    • secretsarray of objects or null
      5 fields per item
      • createdAtdate-time string
      • expiresAtdate-time string or null
      • idstring
      • isActiveboolean
      • prefixstring
  • darkLogoUrlstring or null
  • descriptionstring

    at most 150 characters

  • disabledboolean
  • hasDarkLogoboolean
  • hasLogoboolean
  • idstring

    2 to 128 characters

  • isGroupRestrictedboolean
  • isPublicboolean
  • launchURLstring or null
  • logoUrlstring or null
  • logoutCallbackURLsarray of strings or null
  • pkceEnabledboolean
  • refreshTokenDurationMinutesinteger
  • requiresPushedAuthorizationRequestsboolean
  • requiresReauthenticationboolean
  • skipConsentboolean

Response

201 Createdapplication/json
24 fields
  • accessTokenDurationMinutesinteger
  • allowedUserGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • backchannelLogoutURLstring
  • callbackURLsarray of strings or null
  • claimMappingPolicyIdstring
  • clientTypestring
  • createdSecretobject
    6 fields
    • createdAtdate-time string
    • expiresAtdate-time string or null
    • idstring
    • isActiveboolean
    • prefixstring
    • secretstring
  • credentialsobject
    2 fields
    • federatedIdentitiesarray of objects or null
      6 fields per item
      • audiencestring
      • issuerstring
      • jwksstring
      • publicKeysarray of values or null
      • replayProtectionboolean
      • subjectstring
    • secretsarray of objects or null
      5 fields per item
      • createdAtdate-time string
      • expiresAtdate-time string or null
      • idstring
      • isActiveboolean
      • prefixstring
  • descriptionstring
  • disabledboolean
  • hasDarkLogoboolean
  • hasLogoboolean
  • idstring
  • isGroupRestrictedboolean
  • isPublicboolean
  • launchURLstring or null
  • logoutCallbackURLsarray of strings or null
  • namestring
  • pkceEnabledboolean
  • pkceSupportedboolean
  • refreshTokenDurationMinutesinteger
  • requiresPushedAuthorizationRequestsboolean
  • requiresReauthenticationboolean
  • skipConsentboolean
get/api/oidc/clients/{id}

Get detailed information about an OIDC client

Path parameters

  • idstringrequired

    Client ID

Response

200 OKapplication/json
23 fields
  • accessTokenDurationMinutesinteger
  • allowedUserGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • backchannelLogoutURLstring
  • callbackURLsarray of strings or null
  • claimMappingPolicyIdstring
  • clientTypestring
  • credentialsobject
    2 fields
    • federatedIdentitiesarray of objects or null
      6 fields per item
      • audiencestring
      • issuerstring
      • jwksstring
      • publicKeysarray of values or null
      • replayProtectionboolean
      • subjectstring
    • secretsarray of objects or null
      5 fields per item
      • createdAtdate-time string
      • expiresAtdate-time string or null
      • idstring
      • isActiveboolean
      • prefixstring
  • descriptionstring
  • disabledboolean
  • hasDarkLogoboolean
  • hasLogoboolean
  • idstring
  • isGroupRestrictedboolean
  • isPublicboolean
  • launchURLstring or null
  • logoutCallbackURLsarray of strings or null
  • namestring
  • pkceEnabledboolean
  • pkceSupportedboolean
  • refreshTokenDurationMinutesinteger
  • requiresPushedAuthorizationRequestsboolean
  • requiresReauthenticationboolean
  • skipConsentboolean
put/api/oidc/clients/{id}

Update an existing OIDC client, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    Client ID

Body application/json

  • namestringrequired

    at most 50 characters

  • accessTokenDurationMinutesinteger
  • backchannelLogoutURLstring
  • callbackURLsarray of strings or null
  • claimMappingPolicyIdstring
  • credentialsobject
    2 fields
    • federatedIdentitiesarray of objects or null
      6 fields per item
      • audiencestring
      • issuerstring
      • jwksstring
      • publicKeysarray of values or null
      • replayProtectionboolean
      • subjectstring
    • secretsarray of objects or null
      5 fields per item
      • createdAtdate-time string
      • expiresAtdate-time string or null
      • idstring
      • isActiveboolean
      • prefixstring
  • darkLogoUrlstring or null
  • descriptionstring

    at most 150 characters

  • disabledboolean
  • hasDarkLogoboolean
  • hasLogoboolean
  • isGroupRestrictedboolean
  • isPublicboolean
  • launchURLstring or null
  • logoUrlstring or null
  • logoutCallbackURLsarray of strings or null
  • pkceEnabledboolean
  • refreshTokenDurationMinutesinteger
  • requiresPushedAuthorizationRequestsboolean
  • requiresReauthenticationboolean
  • skipConsentboolean

Response

200 OKapplication/json
23 fields
  • accessTokenDurationMinutesinteger
  • allowedUserGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • backchannelLogoutURLstring
  • callbackURLsarray of strings or null
  • claimMappingPolicyIdstring
  • clientTypestring
  • credentialsobject
    2 fields
    • federatedIdentitiesarray of objects or null
      6 fields per item
      • audiencestring
      • issuerstring
      • jwksstring
      • publicKeysarray of values or null
      • replayProtectionboolean
      • subjectstring
    • secretsarray of objects or null
      5 fields per item
      • createdAtdate-time string
      • expiresAtdate-time string or null
      • idstring
      • isActiveboolean
      • prefixstring
  • descriptionstring
  • disabledboolean
  • hasDarkLogoboolean
  • hasLogoboolean
  • idstring
  • isGroupRestrictedboolean
  • isPublicboolean
  • launchURLstring or null
  • logoutCallbackURLsarray of strings or null
  • namestring
  • pkceEnabledboolean
  • pkceSupportedboolean
  • refreshTokenDurationMinutesinteger
  • requiresPushedAuthorizationRequestsboolean
  • requiresReauthenticationboolean
  • skipConsentboolean
patch/api/oidc/clients/{id}

Update an existing OIDC client, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    Client ID

Body application/json, application/merge-patch+json

  • accessTokenDurationMinutesinteger
  • backchannelLogoutURLstring
  • callbackURLsarray of strings or null
  • claimMappingPolicyIdstring
  • credentialsobject
    2 fields
    • federatedIdentitiesarray of objects or null
      6 fields per item
      • audiencestring
      • issuerstring
      • jwksstring
      • publicKeysarray of values or null
      • replayProtectionboolean
      • subjectstring
    • secretsarray of objects or null
      5 fields per item
      • createdAtdate-time string
      • expiresAtdate-time string or null
      • idstring
      • isActiveboolean
      • prefixstring
  • darkLogoUrlstring or null
  • descriptionstring

    at most 150 characters

  • disabledboolean
  • hasDarkLogoboolean
  • hasLogoboolean
  • isGroupRestrictedboolean
  • isPublicboolean
  • launchURLstring or null
  • logoUrlstring or null
  • logoutCallbackURLsarray of strings or null
  • namestring

    at most 50 characters

  • pkceEnabledboolean
  • refreshTokenDurationMinutesinteger
  • requiresPushedAuthorizationRequestsboolean
  • requiresReauthenticationboolean
  • skipConsentboolean

Response

200 OKapplication/json
23 fields
  • accessTokenDurationMinutesinteger
  • allowedUserGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • backchannelLogoutURLstring
  • callbackURLsarray of strings or null
  • claimMappingPolicyIdstring
  • clientTypestring
  • credentialsobject
    2 fields
    • federatedIdentitiesarray of objects or null
      6 fields per item
      • audiencestring
      • issuerstring
      • jwksstring
      • publicKeysarray of values or null
      • replayProtectionboolean
      • subjectstring
    • secretsarray of objects or null
      5 fields per item
      • createdAtdate-time string
      • expiresAtdate-time string or null
      • idstring
      • isActiveboolean
      • prefixstring
  • descriptionstring
  • disabledboolean
  • hasDarkLogoboolean
  • hasLogoboolean
  • idstring
  • isGroupRestrictedboolean
  • isPublicboolean
  • launchURLstring or null
  • logoutCallbackURLsarray of strings or null
  • namestring
  • pkceEnabledboolean
  • pkceSupportedboolean
  • refreshTokenDurationMinutesinteger
  • requiresPushedAuthorizationRequestsboolean
  • requiresReauthenticationboolean
  • skipConsentboolean
delete/api/oidc/clients/{id}

Delete an OIDC client by ID

Path parameters

  • idstringrequired

    Client ID

Response

204 No Content
put/api/oidc/clients/{id}/allowed-user-groups

Update the user groups allowed to access an OIDC client

Path parameters

  • idstringrequired

    Client ID

Body application/json

  • userGroupIdsarray of stringsrequired

Response

200 OKapplication/json
22 fields
  • accessTokenDurationMinutesinteger
  • backchannelLogoutURLstring
  • callbackURLsarray of strings or null
  • claimMappingPolicyIdstring
  • clientTypestring
  • credentialsobject
    2 fields
    • federatedIdentitiesarray of objects or null
      6 fields per item
      • audiencestring
      • issuerstring
      • jwksstring
      • publicKeysarray of values or null
      • replayProtectionboolean
      • subjectstring
    • secretsarray of objects or null
      5 fields per item
      • createdAtdate-time string
      • expiresAtdate-time string or null
      • idstring
      • isActiveboolean
      • prefixstring
  • descriptionstring
  • disabledboolean
  • hasDarkLogoboolean
  • hasLogoboolean
  • idstring
  • isGroupRestrictedboolean
  • isPublicboolean
  • launchURLstring or null
  • logoutCallbackURLsarray of strings or null
  • namestring
  • pkceEnabledboolean
  • pkceSupportedboolean
  • refreshTokenDurationMinutesinteger
  • requiresPushedAuthorizationRequestsboolean
  • requiresReauthenticationboolean
  • skipConsentboolean
get/api/oidc/clients/{id}/logo

Get the logo image for an OIDC client

Path parameters

  • idstringrequired

    Client ID

Query parameters

  • lightboolean

    Light mode logo (true) or dark mode logo (false)

    defaults to true

Response

200 Logo imageimage/jpeg, image/png, image/svg+xml
post/api/oidc/clients/{id}/logo

Upload or update the logo for an OIDC client

Path parameters

  • idstringrequired

    Client ID

Query parameters

  • lightboolean

    Light mode logo (true) or dark mode logo (false)

    defaults to true

Body multipart/form-data

  • filebinaryrequired

    Logo image file (PNG, JPG, or SVG)

Response

204 No Content
delete/api/oidc/clients/{id}/logo

Delete the logo for an OIDC client

Path parameters

  • idstringrequired

    Client ID

Query parameters

  • lightboolean

    Light mode logo (true) or dark mode logo (false)

    defaults to true

Response

204 No Content
get/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

  • idstringrequired

    Client ID

  • userIdstringrequired

    User ID to preview data for

Query parameters

  • scopesstring

    Scopes to include in the preview (space-separated)

Response

200 OKapplication/json
3 fields
  • accessTokenmap of values or null
  • idTokenmap of values or null
  • userInfomap of values or null
post/api/oidc/clients/{id}/refresh

Force a re-fetch of the OAuth Client ID Metadata Document for a CIMD client

Path parameters

  • idstringrequired

    Client ID

Response

200 OKapplication/json
23 fields
  • accessTokenDurationMinutesinteger
  • allowedUserGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • backchannelLogoutURLstring
  • callbackURLsarray of strings or null
  • claimMappingPolicyIdstring
  • clientTypestring
  • credentialsobject
    2 fields
    • federatedIdentitiesarray of objects or null
      6 fields per item
      • audiencestring
      • issuerstring
      • jwksstring
      • publicKeysarray of values or null
      • replayProtectionboolean
      • subjectstring
    • secretsarray of objects or null
      5 fields per item
      • createdAtdate-time string
      • expiresAtdate-time string or null
      • idstring
      • isActiveboolean
      • prefixstring
  • descriptionstring
  • disabledboolean
  • hasDarkLogoboolean
  • hasLogoboolean
  • idstring
  • isGroupRestrictedboolean
  • isPublicboolean
  • launchURLstring or null
  • logoutCallbackURLsarray of strings or null
  • namestring
  • pkceEnabledboolean
  • pkceSupportedboolean
  • refreshTokenDurationMinutesinteger
  • requiresPushedAuthorizationRequestsboolean
  • requiresReauthenticationboolean
  • skipConsentboolean
get/api/oidc/clients/{id}/scim-service-provider

Get the SCIM service provider configuration for an OIDC client

Path parameters

  • idstringrequired

    Client ID

Response

200 OKapplication/json
5 fields
  • createdAtdate-time string
  • endpointstring
  • hasTokenboolean
  • idstring
  • lastSyncedAtdate-time string or null
get/api/oidc/clients/{id}/secrets

List the secrets of an OIDC client, without disclosing their values

Path parameters

  • idstringrequired

    Client ID

Response

200 OKapplication/json
5 fields per item
  • createdAtdate-time string
  • expiresAtdate-time string or null
  • idstring
  • isActiveboolean
  • prefixstring
post/api/oidc/clients/{id}/secrets

Add 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

  • idstringrequired

    Client ID

Body application/json

  • expiresAtdate-time string or null
  • secretstring

    at least 16 characters

Response

201 Createdapplication/json
6 fields
  • createdAtdate-time string
  • expiresAtdate-time string or null
  • idstring
  • isActiveboolean
  • prefixstring
  • secretstring
delete/api/oidc/clients/{id}/secrets/{secretId}

Delete a single secret of an OIDC client, making it immediately unusable

Path parameters

  • idstringrequired

    Client ID

  • secretIdstringrequired

    Client secret ID

Response

204 No Content
post/api/oidc/introspect

Pass a token to verify if it is considered valid.

Body application/x-www-form-urlencoded

  • tokenstringrequired

    The token to be introspected

  • client_idstring

    The client whose federated client assertion is sent as the bearer token

  • scopestring

    Space-separated scopes the token must have

  • token_type_hintstring

    The type of the token, access_token or refresh_token

Response

200 Response with the introspection result.application/json
get/api/oidc/logo-presets

Search the icon library for logos that can be used for OIDC clients

Query parameters

  • searchstring

    Search term matched against the icon name

Response

200 OKapplication/json
4 fields per item
  • darkLogoUrlstring or null
  • logoUrlstring
  • namestring
  • referencestring
get/api/oidc/userinfo

Get user information based on the access token

Response

200 User claims based on requested scopesapplication/json
get/api/oidc/users/me/authorized-clients

Get a paginated list of OIDC clients that the current user has authorized

Query parameters

  • searchstring

    Search term to filter clients by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of lastUsedAt, name

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[hasLaunchURL]boolean

    Filter clients by whether a launch URL is configured

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    3 fields per item
    • clientobject
      8 fields
      • clientTypestring
      • descriptionstring
      • hasDarkLogoboolean
      • hasLogoboolean
      • idstring
      • launchURLstring or null
      • namestring
      • requiresReauthenticationboolean
    • lastUsedAtdate-time string
    • scopestring
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
delete/api/oidc/users/me/authorized-clients/{clientId}

Revoke the authorization for a specific OIDC client for the current user

Path parameters

  • clientIdstringrequired

    Client ID to revoke authorization for

Response

204 No Content

List accessible OIDC clients for current user

Section titled “List accessible OIDC clients for current user”
get/api/oidc/users/me/clients

Get a list of OIDC clients that the current user can access

Query parameters

  • searchstring

    Search term to filter clients by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of clientType, createdAt, disabled, isGroupRestricted, lastUsedAt, name, pkceEnabled, pkceSupported, requiresPushedAuthorizationRequests, requiresReauthentication, skipConsent

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[clientType]array of strings

    Only items whose clientType is one of these values

  • filters[disabled]array of booleans

    Only items whose disabled is one of these values

  • filters[isGroupRestricted]array of booleans

    Only items whose isGroupRestricted is one of these values

  • filters[pkceEnabled]array of booleans

    Only items whose pkceEnabled is one of these values

  • filters[pkceSupported]array of booleans

    Only items whose pkceSupported is one of these values

  • filters[requiresPushedAuthorizationRequests]array of booleans

    Only items whose requiresPushedAuthorizationRequests is one of these values

  • filters[requiresReauthentication]array of booleans

    Only items whose requiresReauthentication is one of these values

  • filters[skipConsent]array of booleans

    Only items whose skipConsent is one of these values

  • filters[hasLaunchURL]boolean

    Filter clients by whether a launch URL is configured

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    9 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • lastUsedAtdate-time string or null
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
get/api/oidc/users/{id}/authorized-clients

Get a paginated list of OIDC clients that a specific user has authorized

Path parameters

  • idstringrequired

    User ID

Query parameters

  • searchstring

    Search term to filter clients by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of lastUsedAt, name

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[hasLaunchURL]boolean

    Filter clients by whether a launch URL is configured

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    3 fields per item
    • clientobject
      8 fields
      • clientTypestring
      • descriptionstring
      • hasDarkLogoboolean
      • hasLogoboolean
      • idstring
      • launchURLstring or null
      • namestring
      • requiresReauthenticationboolean
    • lastUsedAtdate-time string
    • scopestring
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
put/api/user-groups/{id}/allowed-oidc-clients

Update the OIDC clients allowed for a specific user group

Path parameters

  • idstringrequired

    User Group ID

Body application/json

  • oidcClientIdsarray of stringsrequired

Response

200 OKapplication/json
8 fields
  • allowedOidcClientsarray of objects or null
    8 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • createdAtdate-time string
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • friendlyNamestring
  • idstring
  • ldapIdstring or null
  • namestring
  • usersarray of objects or null
    14 fields per item
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • disabledboolean
    • displayNamestring
    • emailstring or null
    • emailVerificationDeadlinedate-time string or null
    • emailVerifiedboolean
    • firstNamestring
    • idstring
    • isAdminboolean
    • lastNamestring or null
    • ldapIdstring or null
    • localestring or null
    • userGroupsarray of objects or null
      7 fields per item
      • createdAtdate-time string
      • customClaimsarray of objects or null
        2 fields per item
        • keystring
        • valuestring
      • friendlyNamestring
      • idstring
      • ldapIdstring or null
      • namestring
      • userCountinteger
    • usernamestring

Scopes of your own that clients can request besides the built-in ones.

get/api/oidc/custom-scopes

Get a paginated list of the custom OIDC scopes with optional search and sorting

Query parameters

  • searchstring

    Search term to filter scopes by key or name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of createdAt, key, name

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    6 fields per item
    • createdAtdate-time string
    • descriptionstring

      at most 1000 characters

    • idstring
    • keystring

      at most 128 characters

    • namestring

      at most 255 characters

    • policiesarray of strings or null
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
post/api/oidc/custom-scopes

Create a custom OIDC scope, which claim mappings can then be released with

Body application/json

  • descriptionstringrequired

    at most 1000 characters

  • keystringrequired

    at most 128 characters

  • namestringrequired

    at most 255 characters

  • createdAtdate-time string
  • idstring
  • policiesarray of strings or null

Response

201 Createdapplication/json
6 fields
  • createdAtdate-time string
  • descriptionstring

    at most 1000 characters

  • idstring
  • keystring

    at most 128 characters

  • namestring

    at most 255 characters

  • policiesarray of strings or null
get/api/oidc/custom-scopes/keys

Get the keys of every custom OIDC scope, sorted, for pickers that offer all of them at once

Response

200 OKapplication/json
put/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

  • idstringrequired

    Custom scope ID

Body application/json

  • descriptionstringrequired

    at most 1000 characters

  • keystringrequired

    at most 128 characters

  • namestringrequired

    at most 255 characters

  • createdAtdate-time string
  • idstring
  • policiesarray of strings or null

Response

200 OKapplication/json
6 fields
  • createdAtdate-time string
  • descriptionstring

    at most 1000 characters

  • idstring
  • keystring

    at most 128 characters

  • namestring

    at most 255 characters

  • policiesarray of strings or null
patch/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

  • idstringrequired

    Custom scope ID

Body application/json, application/merge-patch+json

  • createdAtdate-time string
  • descriptionstring

    at most 1000 characters

  • idstring
  • keystring

    at most 128 characters

  • namestring

    at most 255 characters

  • policiesarray of strings or null

Response

200 OKapplication/json
6 fields
  • createdAtdate-time string
  • descriptionstring

    at most 1000 characters

  • idstring
  • keystring

    at most 128 characters

  • namestring

    at most 255 characters

  • policiesarray of strings or null
delete/api/oidc/custom-scopes/{id}

Delete a custom OIDC scope that no claim mapping is released with

Path parameters

  • idstringrequired

    Custom scope ID

Response

204 No Content

Policies that decide which claims the tokens of a scope carry and who may request it.

get/api/oidc/claim-mapping-policies

Get a paginated list of OIDC claim mapping policies with optional search and sorting

Query parameters

  • searchstring

    Search term to filter claim mapping policies by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of createdAt, isDefault, name

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    6 fields per item
    • claimCountinteger
    • clientCountinteger
    • createdAtdate-time string
    • idstring
    • isDefaultboolean
    • namestring

      at most 255 characters

  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
post/api/oidc/claim-mapping-policies

Create a new OIDC claim mapping policy

Body application/json

  • namestringrequired

    at most 255 characters

  • claimCountinteger
  • claimMappingsarray of objects or null
    7 fields per item
    • claimNamestringrequired

      at most 255 characters

    • sourceTypestringrequired

      One of user_field, custom_claim, static

    • sourceValuestringrequired

      at most 255 characters

    • accessTokenboolean
    • idTokenboolean
    • scopearray of strings

      at least 1 items

    • userInfoboolean
  • clientCountinteger
  • createdAtdate-time string
  • idstring
  • isDefaultboolean

Response

201 Createdapplication/json
7 fields
  • claimCountinteger
  • claimMappingsarray of objects or null
    7 fields per item
    • accessTokenboolean
    • claimNamestring

      at most 255 characters

    • idTokenboolean
    • scopearray of strings

      at least 1 items

    • sourceTypestring

      One of user_field, custom_claim, static

    • sourceValuestring

      at most 255 characters

    • userInfoboolean
  • clientCountinteger
  • createdAtdate-time string
  • idstring
  • isDefaultboolean
  • namestring

    at most 255 characters

post/api/oidc/claim-mapping-policies/preview

Get the claims that claim mappings, saved or not, release for a user and set of scopes

Body application/json

  • userIdstringrequired
  • claimMappingsarray of objects or null
    7 fields per item
    • claimNamestringrequired

      at most 255 characters

    • sourceTypestringrequired

      One of user_field, custom_claim, static

    • sourceValuestringrequired

      at most 255 characters

    • accessTokenboolean
    • idTokenboolean
    • scopearray of strings

      at least 1 items

    • userInfoboolean
  • scopesarray of strings or null

Response

200 OKapplication/json
3 fields
  • accessTokenmap of values or null
  • idTokenmap of values or null
  • userInfomap of values or null
get/api/oidc/claim-mapping-policies/{id}

Retrieve an existing OIDC claim mapping policy

Path parameters

  • idstringrequired

    Claim mapping policy ID

Response

200 OKapplication/json
7 fields
  • claimCountinteger
  • claimMappingsarray of objects or null
    7 fields per item
    • accessTokenboolean
    • claimNamestring

      at most 255 characters

    • idTokenboolean
    • scopearray of strings

      at least 1 items

    • sourceTypestring

      One of user_field, custom_claim, static

    • sourceValuestring

      at most 255 characters

    • userInfoboolean
  • clientCountinteger
  • createdAtdate-time string
  • idstring
  • isDefaultboolean
  • namestring

    at most 255 characters

put/api/oidc/claim-mapping-policies/{id}

Update an existing OIDC claim mapping policy, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    Claim mapping policy ID

Body application/json

  • namestringrequired

    at most 255 characters

  • claimCountinteger
  • claimMappingsarray of objects or null
    7 fields per item
    • claimNamestringrequired

      at most 255 characters

    • sourceTypestringrequired

      One of user_field, custom_claim, static

    • sourceValuestringrequired

      at most 255 characters

    • accessTokenboolean
    • idTokenboolean
    • scopearray of strings

      at least 1 items

    • userInfoboolean
  • clientCountinteger
  • createdAtdate-time string
  • idstring
  • isDefaultboolean

Response

200 OKapplication/json
7 fields
  • claimCountinteger
  • claimMappingsarray of objects or null
    7 fields per item
    • accessTokenboolean
    • claimNamestring

      at most 255 characters

    • idTokenboolean
    • scopearray of strings

      at least 1 items

    • sourceTypestring

      One of user_field, custom_claim, static

    • sourceValuestring

      at most 255 characters

    • userInfoboolean
  • clientCountinteger
  • createdAtdate-time string
  • idstring
  • isDefaultboolean
  • namestring

    at most 255 characters

patch/api/oidc/claim-mapping-policies/{id}

Update an existing OIDC claim mapping policy, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    Claim mapping policy ID

Body application/json, application/merge-patch+json

  • claimCountinteger
  • claimMappingsarray of objects or null
    7 fields per item
    • claimNamestringrequired

      at most 255 characters

    • sourceTypestringrequired

      One of user_field, custom_claim, static

    • sourceValuestringrequired

      at most 255 characters

    • accessTokenboolean
    • idTokenboolean
    • scopearray of strings

      at least 1 items

    • userInfoboolean
  • clientCountinteger
  • createdAtdate-time string
  • idstring
  • isDefaultboolean
  • namestring

    at most 255 characters

Response

200 OKapplication/json
7 fields
  • claimCountinteger
  • claimMappingsarray of objects or null
    7 fields per item
    • accessTokenboolean
    • claimNamestring

      at most 255 characters

    • idTokenboolean
    • scopearray of strings

      at least 1 items

    • sourceTypestring

      One of user_field, custom_claim, static

    • sourceValuestring

      at most 255 characters

    • userInfoboolean
  • clientCountinteger
  • createdAtdate-time string
  • idstring
  • isDefaultboolean
  • namestring

    at most 255 characters

delete/api/oidc/claim-mapping-policies/{id}

Delete an OIDC claim mapping policy by ID

Path parameters

  • idstringrequired

    Claim mapping policy ID

Response

204 No Content

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”
get/api/oidc/claim-mapping-policies/{id}/assignable-clients

Get a paginated list of the OIDC clients that are not on this claim mapping policy yet

Path parameters

  • idstringrequired

    Claim mapping policy ID

Query parameters

  • searchstring

    Search term to filter clients by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of clientType, createdAt, disabled, isGroupRestricted, name, pkceEnabled, pkceSupported, requiresPushedAuthorizationRequests, requiresReauthentication, skipConsent

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[clientType]array of strings

    Only items whose clientType is one of these values

  • filters[disabled]array of booleans

    Only items whose disabled is one of these values

  • filters[isGroupRestricted]array of booleans

    Only items whose isGroupRestricted is one of these values

  • filters[pkceEnabled]array of booleans

    Only items whose pkceEnabled is one of these values

  • filters[pkceSupported]array of booleans

    Only items whose pkceSupported is one of these values

  • filters[requiresPushedAuthorizationRequests]array of booleans

    Only items whose requiresPushedAuthorizationRequests is one of these values

  • filters[requiresReauthentication]array of booleans

    Only items whose requiresReauthentication is one of these values

  • filters[skipConsent]array of booleans

    Only items whose skipConsent is one of these values

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    8 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger

List OIDC clients using a claim mapping policy

Section titled “List OIDC clients using a claim mapping policy”
get/api/oidc/claim-mapping-policies/{id}/clients

Get a paginated list of the OIDC clients assigned to a claim mapping policy

Path parameters

  • idstringrequired

    Claim mapping policy ID

Query parameters

  • searchstring

    Search term to filter clients by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of clientType, createdAt, disabled, isGroupRestricted, name, pkceEnabled, pkceSupported, requiresPushedAuthorizationRequests, requiresReauthentication, skipConsent

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[clientType]array of strings

    Only items whose clientType is one of these values

  • filters[disabled]array of booleans

    Only items whose disabled is one of these values

  • filters[isGroupRestricted]array of booleans

    Only items whose isGroupRestricted is one of these values

  • filters[pkceEnabled]array of booleans

    Only items whose pkceEnabled is one of these values

  • filters[pkceSupported]array of booleans

    Only items whose pkceSupported is one of these values

  • filters[requiresPushedAuthorizationRequests]array of booleans

    Only items whose requiresPushedAuthorizationRequests is one of these values

  • filters[requiresReauthentication]array of booleans

    Only items whose requiresReauthentication is one of these values

  • filters[skipConsent]array of booleans

    Only items whose skipConsent is one of these values

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    8 fields per item
    • clientTypestring
    • descriptionstring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • launchURLstring or null
    • namestring
    • requiresReauthenticationboolean
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger

Assign an OIDC client to a claim mapping policy

Section titled “Assign an OIDC client to a claim mapping policy”
post/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

  • idstringrequired

    Claim mapping policy ID

  • clientIdstringrequired

    OIDC Client ID

Response

204 No Content

Detach an OIDC client from a claim mapping policy

Section titled “Detach an OIDC client from a claim mapping policy”
delete/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

  • idstringrequired

    Claim mapping policy ID

  • clientIdstringrequired

    OIDC Client ID

Response

204 No Content

Your own APIs, their permissions and the clients that may request them.

get/api/api-access/{clientId}/apis

Get 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

  • clientIdstringrequired

    OIDC Client ID

Response

200 OKapplication/json
7 fields per item
  • apiobject
    6 fields
    • allowCimdClientsboolean
    • createdAtdate-time string
    • idstring
    • namestring
    • permissionsarray of objects or null
      5 fields per item
      • allowedForCimdClientsboolean
      • descriptionstring or null
      • idstring
      • keystring
      • namestring
    • resourcestring
  • cimdGrantedAccessboolean
  • cimdGrantedPermissionIdsarray of strings or null
  • clientAccessboolean
  • clientPermissionIdsarray of strings or null
  • userDelegatedAccessboolean
  • userDelegatedPermissionIdsarray 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”
get/api/api-access/{clientId}/assignable-apis

Get a paginated list of APIs the OIDC client cannot already reach

Path parameters

  • clientIdstringrequired

    OIDC Client ID

Query parameters

  • searchstring

    Search term to filter APIs by name or resource

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of audience, createdAt, name, resource

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    6 fields per item
    • allowCimdClientsboolean
    • createdAtdate-time string
    • idstring
    • namestring
    • permissionsarray of objects or null
      5 fields per item
      • allowedForCimdClientsboolean
      • descriptionstring or null
      • idstring
      • keystring
      • namestring
    • resourcestring
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
get/api/apis

Get a paginated list of APIs with optional search and sorting

Query parameters

  • searchstring

    Search term to filter APIs by name or resource

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of audience, createdAt, name, resource

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    6 fields per item
    • allowCimdClientsboolean
    • createdAtdate-time string
    • idstring
    • namestring
    • permissionsarray of objects or null
      5 fields per item
      • allowedForCimdClientsboolean
      • descriptionstring or null
      • idstring
      • keystring
      • namestring
    • resourcestring
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
post/api/apis

Create a new API resource server

Body application/json

  • namestringrequired

    1 to 50 characters

  • resourcestringrequired

    at most 350 characters

Response

201 Createdapplication/json
6 fields
  • allowCimdClientsboolean
  • createdAtdate-time string
  • idstring
  • namestring
  • permissionsarray of objects or null
    5 fields per item
    • allowedForCimdClientsboolean
    • descriptionstring or null
    • idstring
    • keystring
    • namestring
  • resourcestring
get/api/apis/{id}

Retrieve a single API including its permissions

Path parameters

  • idstringrequired

    API ID

Response

200 OKapplication/json
6 fields
  • allowCimdClientsboolean
  • createdAtdate-time string
  • idstring
  • namestring
  • permissionsarray of objects or null
    5 fields per item
    • allowedForCimdClientsboolean
    • descriptionstring or null
    • idstring
    • keystring
    • namestring
  • resourcestring
put/api/apis/{id}

Update an existing API by ID, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    API ID

Body application/json

  • namestringrequired

    1 to 50 characters

Response

200 OKapplication/json
6 fields
  • allowCimdClientsboolean
  • createdAtdate-time string
  • idstring
  • namestring
  • permissionsarray of objects or null
    5 fields per item
    • allowedForCimdClientsboolean
    • descriptionstring or null
    • idstring
    • keystring
    • namestring
  • resourcestring
patch/api/apis/{id}

Update an existing API by ID, where PATCH changes only the fields in the body

Path parameters

  • idstringrequired

    API ID

Body application/json, application/merge-patch+json

  • namestring

    1 to 50 characters

Response

200 OKapplication/json
6 fields
  • allowCimdClientsboolean
  • createdAtdate-time string
  • idstring
  • namestring
  • permissionsarray of objects or null
    5 fields per item
    • allowedForCimdClientsboolean
    • descriptionstring or null
    • idstring
    • keystring
    • namestring
  • resourcestring
delete/api/apis/{id}

Delete an API by ID

Path parameters

  • idstringrequired

    API ID

Response

204 No Content

List clients that can still be granted access to an API

Section titled “List clients that can still be granted access to an API”
get/api/apis/{id}/assignable-clients

Get a paginated list of OIDC clients that have no grant on the API yet

Path parameters

  • idstringrequired

    API ID

Query parameters

  • searchstring

    Search term to filter clients by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of clientType, createdAt, disabled, isGroupRestricted, name, pkceEnabled, pkceSupported, requiresPushedAuthorizationRequests, requiresReauthentication, skipConsent

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[clientType]array of strings

    Only items whose clientType is one of these values

  • filters[disabled]array of booleans

    Only items whose disabled is one of these values

  • filters[isGroupRestricted]array of booleans

    Only items whose isGroupRestricted is one of these values

  • filters[pkceEnabled]array of booleans

    Only items whose pkceEnabled is one of these values

  • filters[pkceSupported]array of booleans

    Only items whose pkceSupported is one of these values

  • filters[requiresPushedAuthorizationRequests]array of booleans

    Only items whose requiresPushedAuthorizationRequests is one of these values

  • filters[requiresReauthentication]array of booleans

    Only items whose requiresReauthentication is one of these values

  • filters[skipConsent]array of booleans

    Only items whose skipConsent is one of these values

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    6 fields per item
    • clientTypestring
    • hasDarkLogoboolean
    • hasLogoboolean
    • idstring
    • isPublicboolean
    • namestring
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
put/api/apis/{id}/cimd-access

Replace which permissions of an API every client registered through a Client ID Metadata Document may request

Path parameters

  • idstringrequired

    API ID

Body application/json

  • enabledboolean
  • permissionIdsarray of strings or null

Response

200 OKapplication/json
6 fields
  • allowCimdClientsboolean
  • createdAtdate-time string
  • idstring
  • namestring
  • permissionsarray of objects or null
    5 fields per item
    • allowedForCimdClientsboolean
    • descriptionstring or null
    • idstring
    • keystring
    • namestring
  • resourcestring
get/api/apis/{id}/clients

Get 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

  • idstringrequired

    API ID

Query parameters

  • searchstring

    Search term to filter clients by name

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of clientType, createdAt, disabled, isGroupRestricted, name, pkceEnabled, pkceSupported, requiresPushedAuthorizationRequests, requiresReauthentication, skipConsent

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[clientType]array of strings

    Only items whose clientType is one of these values

  • filters[disabled]array of booleans

    Only items whose disabled is one of these values

  • filters[isGroupRestricted]array of booleans

    Only items whose isGroupRestricted is one of these values

  • filters[pkceEnabled]array of booleans

    Only items whose pkceEnabled is one of these values

  • filters[pkceSupported]array of booleans

    Only items whose pkceSupported is one of these values

  • filters[requiresPushedAuthorizationRequests]array of booleans

    Only items whose requiresPushedAuthorizationRequests is one of these values

  • filters[requiresReauthentication]array of booleans

    Only items whose requiresReauthentication is one of these values

  • filters[skipConsent]array of booleans

    Only items whose skipConsent is one of these values

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    7 fields per item
    • cimdGrantedAccessboolean
    • cimdGrantedPermissionIdsarray of strings or null
    • clientobject
      6 fields
      • clientTypestring
      • hasDarkLogoboolean
      • hasLogoboolean
      • idstring
      • isPublicboolean
      • namestring
    • clientAccessboolean
    • clientPermissionIdsarray of strings or null
    • userDelegatedAccessboolean
    • userDelegatedPermissionIdsarray of strings or null
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
put/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

  • idstringrequired

    API ID

  • clientIdstringrequired

    OIDC Client ID

Body application/json

  • clientAccessboolean
  • clientPermissionIdsarray of strings or null
  • userDelegatedAccessboolean
  • userDelegatedPermissionIdsarray of strings or null

Response

200 OKapplication/json
4 fields
  • clientAccessboolean
  • clientPermissionIdsarray of strings or null
  • userDelegatedAccessboolean
  • userDelegatedPermissionIdsarray of strings or null
delete/api/apis/{id}/clients/{clientId}

Remove every permission of this API a single OIDC client was allowed to request

Path parameters

  • idstringrequired

    API ID

  • clientIdstringrequired

    OIDC Client ID

Response

204 No Content
put/api/apis/{id}/permissions

Replace the full set of permissions for an API

Path parameters

  • idstringrequired

    API ID

Body application/json

  • permissionsarray of objects or null
    3 fields per item
    • keystringrequired

      1 to 128 characters

    • namestringrequired

      1 to 50 characters

    • descriptionstring or null

      at most 200 characters

Response

200 OKapplication/json
6 fields
  • allowCimdClientsboolean
  • createdAtdate-time string
  • idstring
  • namestring
  • permissionsarray of objects or null
    5 fields per item
    • allowedForCimdClientsboolean
    • descriptionstring or null
    • idstring
    • keystring
    • namestring
  • resourcestring

Extra claims that Pocket ID adds to the tokens of a user or of every member of a group.

get/api/custom-claims/suggestions

Get a list of suggested custom claim names

Response

200 OKapplication/json
put/api/custom-claims/user-group/{userGroupId}

Update or create custom claims for a specific user group

Path parameters

  • userGroupIdstringrequired

    User Group ID

Body application/json

An array, with these fields per item:

  • keystringrequired
  • valuestringrequired

Response

200 OKapplication/json
2 fields per item
  • keystring
  • valuestring
put/api/custom-claims/user/{userId}

Update or create custom claims for a specific user

Path parameters

  • userIdstringrequired

    User ID

Body application/json

An array, with these fields per item:

  • keystringrequired
  • valuestringrequired

Response

200 OKapplication/json
2 fields per item
  • keystring
  • valuestring

Keys for this REST API.

get/api/api-keys

Get a paginated list of API keys belonging to the current user

Query parameters

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of createdAt, expiresAt, lastUsedAt, name

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    9 fields per item
    • createdAtdate-time string
    • descriptionstring or null
    • expirationEmailSentboolean
    • expiresAtdate-time string
    • idstring
    • lastUsedAtdate-time string or null
    • namestring
    • previousKeyExpiresAtdate-time string or null
    • scopesarray of strings or null
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
post/api/api-keys

Create a new API key for the current user

Body application/json

  • expiresAtdate-time stringrequired
  • namestringrequired

    3 to 50 characters

  • scopesarray of stringsrequired

    at least 1 items

  • descriptionstring or null

Response

201 Createdapplication/json
2 fields
  • apiKeyobject
    9 fields
    • createdAtdate-time string
    • descriptionstring or null
    • expirationEmailSentboolean
    • expiresAtdate-time string
    • idstring
    • lastUsedAtdate-time string or null
    • namestring
    • previousKeyExpiresAtdate-time string or null
    • scopesarray of strings or null
  • tokenstring
put/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

  • idstringrequired

    API Key ID

Body application/json

  • namestringrequired

    3 to 50 characters

  • scopesarray of stringsrequired

    at least 1 items

  • descriptionstring or null

Response

200 OKapplication/json
9 fields
  • createdAtdate-time string
  • descriptionstring or null
  • expirationEmailSentboolean
  • expiresAtdate-time string
  • idstring
  • lastUsedAtdate-time string or null
  • namestring
  • previousKeyExpiresAtdate-time string or null
  • scopesarray of strings or null
patch/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

  • idstringrequired

    API Key ID

Body application/json, application/merge-patch+json

  • descriptionstring or null
  • namestring

    3 to 50 characters

  • scopesarray of strings

    at least 1 items

Response

200 OKapplication/json
9 fields
  • createdAtdate-time string
  • descriptionstring or null
  • expirationEmailSentboolean
  • expiresAtdate-time string
  • idstring
  • lastUsedAtdate-time string or null
  • namestring
  • previousKeyExpiresAtdate-time string or null
  • scopesarray of strings or null
delete/api/api-keys/{id}

Revoke (delete) an existing API key by ID

Path parameters

  • idstringrequired

    API Key ID

Response

204 No Content
post/api/api-keys/{id}/renew

While 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

  • idstringrequired

    API Key ID

Body application/json

  • expiresAtdate-time stringrequired
  • gracePeriodHoursinteger

    at least 0

Response

200 OKapplication/json
2 fields
  • apiKeyobject
    9 fields
    • createdAtdate-time string
    • descriptionstring or null
    • expirationEmailSentboolean
    • expiresAtdate-time string
    • idstring
    • lastUsedAtdate-time string or null
    • namestring
    • previousKeyExpiresAtdate-time string or null
    • scopesarray of strings or null
  • tokenstring

The sign-in sessions of the current user or of any user.

get/api/sessions

Get the browsers in which the current user is signed in, most recently active first

Response

200 OKapplication/json
13 fields per item
  • authenticationMethodstring
  • browserstring
  • citystring
  • countrystring
  • createdAtdate-time string
  • currentboolean
  • deviceTypestring
  • expiresAtdate-time string
  • idstring
  • ipAddressstring
  • lastActiveAtdate-time string
  • osstring
  • userAgentstring
delete/api/sessions

Sign the current user out of every session except the current one

Response

204 No Content
post/api/sessions/current/remember

Keep the current session signed in after the browser closes and while it goes unused, for a sign-in that was not remembered

Response

204 No Content
delete/api/sessions/{id}

Sign the current user out of one of their sessions

Path parameters

  • idstringrequired

    Session ID

Response

204 No Content
get/api/users/{id}/sessions

Get the browsers in which a user is signed in, most recently active first

Path parameters

  • idstringrequired

    User ID

Response

200 OKapplication/json
13 fields per item
  • authenticationMethodstring
  • browserstring
  • citystring
  • countrystring
  • createdAtdate-time string
  • currentboolean
  • deviceTypestring
  • expiresAtdate-time string
  • idstring
  • ipAddressstring
  • lastActiveAtdate-time string
  • osstring
  • userAgentstring
delete/api/users/{id}/sessions

Sign a user out of every session and revoke every grant their apps hold, offline_access ones included

Path parameters

  • idstringrequired

    User ID

Response

204 No Content
delete/api/users/{id}/sessions/{sessionId}

Sign a user out of one of their sessions

Path parameters

  • idstringrequired

    User ID

  • sessionIdstringrequired

    Session ID

Response

204 No Content

The settings of the Application Configuration page, the LDAP sync and the test email.

get/api/application-configuration

Get all public application configurations

Response

200 OKapplication/json
3 fields per item
  • keystring
  • typestring
  • valuestring
put/api/application-configuration

Update application configuration settings, where PATCH changes only the fields in the body

Body application/json

  • allowOwnAccountEditstringrequired
  • allowUserSignupsstringrequired

    One of disabled, withToken, open

  • appNamestringrequired

    1 to 30 characters

  • autoCreateOidcClientSecretstringrequired
  • emailApiKeyExpirationEnabledstringrequired
  • emailLoginNotificationModestringrequired

    One of disabled, always, ipAndUserAgent, browserRecognition

  • emailOneTimeAccessAsAdminEnabledstringrequired
  • emailOneTimeAccessAsUnauthenticatedEnabledstringrequired
  • emailVerificationstringrequired

    One of disabled, optional, required

  • emailsVerifiedstringrequired
  • homePageUrlstringrequired
  • ldapEnabledstringrequired
  • ldapSkipCertVerifystringrequired
  • ldapSoftDeleteUsersstringrequired
  • requireUserEmailstringrequired
  • sessionDurationstringrequired
  • smtpSkipCertVerifystringrequired
  • smtpTlsstringrequired

    One of none, starttls, tls

  • webauthnAllowSyncedPasskeysstringrequired
  • webauthnAuthenticatorAttachmentstringrequired

    One of any, platform, cross-platform

  • webauthnUserVerificationstringrequired

    One of required, preferred

  • appearancestring
  • cimdUrlAllowliststring
  • enabledFeaturesstring
  • ldapAdminGroupNamestring
  • ldapAttributeGroupMemberstring
  • ldapAttributeGroupNamestring
  • ldapAttributeGroupUniqueIdentifierstring
  • ldapAttributeUserDisplayNamestring
  • ldapAttributeUserEmailstring
  • ldapAttributeUserFirstNamestring
  • ldapAttributeUserLastNamestring
  • ldapAttributeUserProfilePicturestring
  • ldapAttributeUserUniqueIdentifierstring
  • ldapAttributeUserUsernamestring
  • ldapBasestring
  • ldapBindDnstring
  • ldapBindPasswordstring
  • ldapUrlstring
  • ldapUserGroupSearchFilterstring
  • ldapUserSearchFilterstring
  • signupDefaultCustomClaimsstring
  • signupDefaultUserGroupIDsstring
  • smtpFromstring
  • smtpHoststring
  • smtpPasswordstring
  • smtpPortstring
  • smtpUserstring

Response

200 OKapplication/json
5 fields per item
  • envOverrideboolean
  • isPublicboolean
  • keystring
  • typestring
  • valuestring
patch/api/application-configuration

Update application configuration settings, where PATCH changes only the fields in the body

Body application/json, application/merge-patch+json

  • allowOwnAccountEditstring
  • allowUserSignupsstring

    One of disabled, withToken, open

  • appNamestring

    1 to 30 characters

  • appearancestring
  • autoCreateOidcClientSecretstring
  • cimdUrlAllowliststring
  • emailApiKeyExpirationEnabledstring
  • emailLoginNotificationModestring

    One of disabled, always, ipAndUserAgent, browserRecognition

  • emailOneTimeAccessAsAdminEnabledstring
  • emailOneTimeAccessAsUnauthenticatedEnabledstring
  • emailVerificationstring

    One of disabled, optional, required

  • emailsVerifiedstring
  • enabledFeaturesstring
  • homePageUrlstring
  • ldapAdminGroupNamestring
  • ldapAttributeGroupMemberstring
  • ldapAttributeGroupNamestring
  • ldapAttributeGroupUniqueIdentifierstring
  • ldapAttributeUserDisplayNamestring
  • ldapAttributeUserEmailstring
  • ldapAttributeUserFirstNamestring
  • ldapAttributeUserLastNamestring
  • ldapAttributeUserProfilePicturestring
  • ldapAttributeUserUniqueIdentifierstring
  • ldapAttributeUserUsernamestring
  • ldapBasestring
  • ldapBindDnstring
  • ldapBindPasswordstring
  • ldapEnabledstring
  • ldapSkipCertVerifystring
  • ldapSoftDeleteUsersstring
  • ldapUrlstring
  • ldapUserGroupSearchFilterstring
  • ldapUserSearchFilterstring
  • requireUserEmailstring
  • sessionDurationstring
  • signupDefaultCustomClaimsstring
  • signupDefaultUserGroupIDsstring
  • smtpFromstring
  • smtpHoststring
  • smtpPasswordstring
  • smtpPortstring
  • smtpSkipCertVerifystring
  • smtpTlsstring

    One of none, starttls, tls

  • smtpUserstring
  • webauthnAllowSyncedPasskeysstring
  • webauthnAuthenticatorAttachmentstring

    One of any, platform, cross-platform

  • webauthnUserVerificationstring

    One of required, preferred

Response

200 OKapplication/json
5 fields per item
  • envOverrideboolean
  • isPublicboolean
  • keystring
  • typestring
  • valuestring
get/api/application-configuration/all

Get all application configurations including private ones

Response

200 OKapplication/json
5 fields per item
  • envOverrideboolean
  • isPublicboolean
  • keystring
  • typestring
  • valuestring
post/api/application-configuration/sync-ldap

Manually trigger LDAP synchronization

Response

204 No Content
post/api/application-configuration/test-email

Send a test email to verify email configuration

Response

204 No Content

The logo, favicon, background, font, email logo and default profile picture.

get/api/application-assets/background

Get the background image for the application

Query parameters

  • defaultboolean

    Return the bundled default if no custom one is set

    defaults to true

Response

200 Background imageimage/avif, image/gif, image/heic, image/jpeg, image/png, image/svg+xml, image/webp, image/x-icon
put/api/application-assets/background

Update the application background image

Body multipart/form-data

  • filebinaryrequired

    Background image file

Response

204 No Content
delete/api/application-assets/background

Delete the application background image

Response

204 No Content
get/api/application-assets/default-profile-picture

Get the default profile picture image for the application

Query parameters

  • defaultboolean

    Return the bundled default if no custom one is set

    defaults to true

Response

200 Default profile picture imageimage/avif, image/gif, image/heic, image/jpeg, image/png, image/svg+xml, image/webp, image/x-icon
put/api/application-assets/default-profile-picture

Update the default profile picture image

Body multipart/form-data

  • filebinaryrequired

    Profile picture image file

Response

204 No Content
delete/api/application-assets/default-profile-picture

Delete the default profile picture image

Response

204 No Content
get/api/application-assets/email

Get the email logo image for use in emails

Query parameters

  • defaultboolean

    Return the bundled default if no custom one is set

    defaults to true

Response

200 Email logo imageimage/jpeg, image/png
put/api/application-assets/email

Update the email logo for use in emails

Body multipart/form-data

  • filebinaryrequired

    Email logo image file

Response

204 No Content
get/api/application-assets/favicon

Get the favicon for the application

Query parameters

  • defaultboolean

    Return the bundled default if no custom one is set

    defaults to true

Response

200 Favicon imageimage/png, image/svg+xml, image/x-icon
put/api/application-assets/favicon

Update the application favicon

Body multipart/form-data

  • filebinaryrequired

    Favicon file (.svg/.png/.ico)

Response

204 No Content
get/api/application-assets/font

Get the custom font of page and dialog titles

Query parameters

  • defaultboolean

    Return the bundled default if no custom one is set

    defaults to true

Response

200 Font filefont/otf, font/ttf, font/woff, font/woff2
put/api/application-assets/font

Update the custom font of page and dialog titles

Body multipart/form-data

  • filebinaryrequired

    Font file (.woff2/.woff/.ttf/.otf)

Response

204 No Content
delete/api/application-assets/font

Delete the custom font of page and dialog titles

Response

204 No Content
get/api/application-assets/logo

Get the logo image for the application

Query parameters

  • lightboolean

    Light mode logo (true) or dark mode logo (false)

    defaults to true

  • defaultboolean

    Return the bundled default if no custom one is set

    defaults to true

Response

200 Logo imageimage/avif, image/gif, image/heic, image/jpeg, image/png, image/svg+xml, image/webp, image/x-icon
put/api/application-assets/logo

Update the application logo

Query parameters

  • lightboolean

    Light mode logo (true) or dark mode logo (false)

    defaults to true

Body multipart/form-data

  • filebinaryrequired

    Logo image file

Response

204 No Content
delete/api/application-assets/logo

Delete the custom application logo and restore the default logo

Query parameters

  • lightboolean

    Light mode logo (true) or dark mode logo (false)

    defaults to true

Response

204 No Content

The optional features and whether they are on.

get/api/features

Get whether each optional feature is on and whether anything uses it; a feature in use is always on

Response

200 OKapplication/json

Sign-ins and other security events, of the current user or of everyone.

get/api/audit-logs

Get a paginated list of the audit logs about the current user

Query parameters

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of city, country, createdAt, event, ipAddress, userAgent

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[event]array of strings

    Only items whose event is one of these values

  • fromstring

    Only entries created at or after this RFC 3339 time

  • tostring

    Only entries created before this RFC 3339 time

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    13 fields per item
    • actorIDstring
    • actorNamestring
    • actorTypestring
    • citystring
    • countrystring
    • createdAtdate-time string
    • datamap of strings or null
    • devicestring
    • eventstring
    • idstring
    • ipAddressstring
    • userIDstring
    • usernamestring
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
get/api/audit-logs/all

Get a paginated list of all audit logs (admin only)

Query parameters

  • pagination[page]integer

    Page number for pagination

    defaults to 1

  • pagination[limit]integer

    Number of items per page

    defaults to 20

  • sort[column]string

    Column to sort by

    One of city, country, createdAt, event, ipAddress, userAgent

  • sort[direction]string

    Sort direction

    One of asc, desc · defaults to asc

  • filters[event]array of strings

    Only items whose event is one of these values

  • fromstring

    Only entries created at or after this RFC 3339 time

  • tostring

    Only entries created before this RFC 3339 time

  • filters[userID]string

    Only entries of this user, including the actions they took

  • filters[clientName]array of strings

    Only entries of the OIDC clients with these names

  • filters[location]array of strings

    Only entries from the internal or external network

Response

200 OKapplication/json
2 fields
  • dataarray of objects or null
    13 fields per item
    • actorIDstring
    • actorNamestring
    • actorTypestring
    • citystring
    • countrystring
    • createdAtdate-time string
    • datamap of strings or null
    • devicestring
    • eventstring
    • idstring
    • ipAddressstring
    • userIDstring
    • usernamestring
  • paginationobject
    4 fields
    • currentPageinteger
    • itemsPerPageinteger
    • totalItemsinteger
    • totalPagesinteger
get/api/audit-logs/filters/client-names

Get a list of all client names for audit log filtering

Response

200 OKapplication/json
get/api/audit-logs/filters/users

Get a list of all usernames with their IDs for audit log filtering

Response

200 OKapplication/json

SCIM provisioning of an OIDC client.

post/api/scim/service-provider

Create a new SCIM service provider

Body application/json

  • endpointstringrequired
  • oidcClientIdstringrequired
  • tokenstring or null

Response

201 Createdapplication/json
5 fields
  • createdAtdate-time string
  • endpointstring
  • hasTokenboolean
  • idstring
  • lastSyncedAtdate-time string or null
put/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

  • idstringrequired

    Service Provider ID

Body application/json

  • endpointstringrequired
  • oidcClientIdstringrequired
  • tokenstring or null

Response

200 OKapplication/json
5 fields
  • createdAtdate-time string
  • endpointstring
  • hasTokenboolean
  • idstring
  • lastSyncedAtdate-time string or null
patch/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

  • idstringrequired

    Service Provider ID

Body application/json, application/merge-patch+json

  • endpointstring
  • oidcClientIdstring
  • tokenstring or null

Response

200 OKapplication/json
5 fields
  • createdAtdate-time string
  • endpointstring
  • hasTokenboolean
  • idstring
  • lastSyncedAtdate-time string or null
delete/api/scim/service-provider/{id}

Delete a SCIM service provider by ID

Path parameters

  • idstringrequired

    Service Provider ID

Response

204 No Content
post/api/scim/service-provider/{id}/sync

Trigger synchronization for a SCIM service provider

Path parameters

  • idstringrequired

    Service Provider ID

Response

200 OK

The requests behind sign-in with another device.

post/api/device-login/requests

Create a short-lived request that can be approved from another authenticated device

Response

201 Createdapplication/json
6 fields
  • expiresAtdate-time string
  • idstring
  • intervalinteger
  • userCodestring
  • verificationUristring
  • verificationUriCompletestring
post/api/device-login/requests/{id}/exchange

Wait for a device login decision and create a browser session after it has been approved

Path parameters

  • idstringrequired

    Device login request ID

Query parameters

  • rememberboolean

    Set to false for a session that ends when the browser closes or after 20 minutes without activity

    defaults to true

Responses

200 Approved request exchanged for a user sessionapplication/json
14 fields
  • customClaimsarray of objects or null
    2 fields per item
    • keystring
    • valuestring
  • disabledboolean
  • displayNamestring
  • emailstring or null
  • emailVerificationDeadlinedate-time string or null
  • emailVerifiedboolean
  • firstNamestring
  • idstring
  • isAdminboolean
  • lastNamestring or null
  • ldapIdstring or null
  • localestring or null
  • userGroupsarray of objects or null
    7 fields per item
    • createdAtdate-time string
    • customClaimsarray of objects or null
      2 fields per item
      • keystring
      • valuestring
    • friendlyNamestring
    • idstring
    • ldapIdstring or null
    • namestring
    • userCountinteger
  • usernamestring
202 Authorization pending
post/api/device-login/verification

Retrieve the requesting device details for an authenticated user before approval or denial

Body application/json

  • codestringrequired

Response

200 OKapplication/json
6 fields
  • citystring
  • countrystring
  • devicestring
  • expiresAtdate-time string
  • ipAddressstring
  • userCodestring
post/api/device-login/verification/decision

Approve or deny a device login request; approval requires fresh passkey reauthentication

Body application/json

  • codestringrequired
  • decisionstringrequired

    One of approve, deny

Response

204 No Content

Discovery documents and signing keys, which OIDC clients read without authentication.

get/.well-known/jwks.json

Returns the JSON Web Key Set used for token verification

Response

200 { "keys": []interface{} }application/json

Get OAuth 2.0 authorization server metadata

Section titled “Get OAuth 2.0 authorization server metadata”
get/.well-known/oauth-authorization-server

Returns the RFC 8414 OAuth 2.0 authorization server metadata document with endpoints and capabilities

Response

200 OAuth 2.0 authorization server metadataapplication/json

Get OAuth 2.0 protected resource metadata of the MCP endpoint

Section titled “Get OAuth 2.0 protected resource metadata of the MCP endpoint”
get/.well-known/oauth-protected-resource/mcp

Returns 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

200 OAuth 2.0 protected resource metadataapplication/json

Get OpenID Connect discovery configuration

Section titled “Get OpenID Connect discovery configuration”
get/.well-known/openid-configuration

Returns the OpenID Connect discovery document with endpoints and capabilities

Response

200 OpenID Connect configurationapplication/json

The running version and the latest release.

get/api/version/current

Response

200 OKapplication/json
1 field
  • currentVersionstring
get/api/version/latest

Response

200 OKapplication/json
1 field
  • latestVersionstring

A health check for container orchestrators and load balancers.

get/healthz

Responds with a successful status code to healthcheck requests

Response

204 No Content

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”
get/api/storage/sqlite-warning

Reports whether Pocket ID found its SQLite database on a networked filesystem, which is unsupported and can lead to database corruption

Response

200 OKapplication/json
1 field
  • showWarningboolean