Skip to content
API Reference
/
/
Creates a SCIM token, mus...

Aritma ID API (1)

An API for interacting with Aritma ID

Authorization: each endpoint lists the IAM actions the calling subject must be granted in the tenant (also exposed as x-required-actions). Actions are enforced on the static root scope /; a grant on a narrower scope does not satisfy them. When several actions are listed, all are required. Some endpoints only accept user subjects (x-allowed-subject-types); calling them with a client token returns 400 Bad Request.

Download OpenAPI description
iam-openapi.json
iam-openapi.yaml
Overview
URL
https://aritma.com/contact
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/platform/iam/openapi/iam-openapi

Client

Actions related to clients in Aritma ID

Operations

Domains

Actions related to domains registered for the tenant, and their verification status

Operations

Invitation

Manage user invitations with IAM permissions.

Operations

Me

Actions listing information about the currently authenticated user

Operations

Role

Actions related to Aritma ID roles

Operations

Scim

Actions related to SCIM tokens

Operations

Creates a SCIM token, must be connected to an SSO Provider

Request

The SCIM token secret will only be showed in the response of this endpoint, it will never be shown again, so be sure to copy it.

Security
authorization_code_with_pkce or client_credentials
Bodyapplication/json

The token creation request containing the provider scheme and display name.

providerstringrequired

The scheme name of the identity provider to associate with the token.

providerDisplayNamestringrequired

The human-readable name of the identity provider.

application/json
{
  "provider": "string",
  "providerDisplayName": "string"
}

Responses

OK

Bodyapplication/json
idstringrequired

The unique identifier of the SCIM token.

tokenstringrequired

The secret token value. Store this securely — it will not be shown again.

providerstringrequired

The scheme name of the associated identity provider.

providerDisplayNamestringrequired

The human-readable name of the associated identity provider.

Response
application/json
{
  "id": "string",
  "token": "string",
  "provider": "string",
  "providerDisplayName": "string"
}

Lists all registered SCIM tokens

Request

Required IAM actions (all required, on scope /): tenant.admin

Security
authorization_code_with_pkce or client_credentials
Query
querystring

Optional search term to filter tokens by provider name.

Example: query=azure
pageinteger(int32)

The page number to retrieve (1-based).

Example: page=1
pageSizeinteger(int32)

The number of items per page.

Example: pageSize=10
No request payload

Responses

OK

Bodyapplication/json
tokensArray of objects(ScimTokenDto)required

The SCIM tokens on this page.

idstring(uuid)required

The unique identifier of the SCIM token.

providerstringrequired

The scheme name of the associated identity provider.

providerDisplayNamestringrequired

The human-readable name of the associated identity provider.

createdAtstring(date-time)required

The UTC date and time the token was created.

totalCountinteger(int32)required

Total number of SCIM tokens across all pages.

pageinteger(int32)required

The current page number.

pageSizeinteger(int32)required

The number of items per page.

Response
application/json
{
  "tokens": [
    { … }
  ],
  "totalCount": 0,
  "page": 0,
  "pageSize": 0
}

Deletes a SCIM token by id

Request

Required IAM actions (all required, on scope /): tenant.admin

Security
authorization_code_with_pkce or client_credentials
Path
idstring(uuid)required

The GUID identifier of the SCIM token to delete.

No request payload

Responses

No Content

Response
No content

Scope

Actions related to scopes in Aritma ID

Operations

SSO

Actions common for all SSO providers

Operations

SSO - Azure AD (Entra ID)

Actions relating to AzureAd as an SSO provider

Operations

SSO - Custom Providers

Actions relating to custom SSO providers

Operations

SSO - Google

Actions relating to Google as an SSO provider

Operations

SSO - Signicat

Actions relating to Signicat as an SSO provider

Operations

User

Actions related to Aritma ID users

Operations