Skip to content
/Domains

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

Gets registered domains

Request

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

Security
authorization_code_with_pkce or client_credentials
Query
filterstring

The string used to filter the request

No request payload

Responses

OK

Bodyapplication/jsonArray [
domainstringrequired

The domain name (e.g. "example.com").

Example: "aritma.com"
statusstringrequired

The current verification status of the domain.

Enum"NotRegistered""Pending""Confirmed"
Example: "Pending"
verificationTokenstring or null

A DNS TXT token that must be published to verify ownership of the domain. Removed once verified.

Example: "aritma-verify-00000000-0000-0000-0000-000000000000"
]
Response
application/json
[
  {
    "domain": "aritma.com",
    "status": "Pending",
    "verificationToken": "aritma-verify-00000000-0000-0000-0000-000000000000"
  }
]

Registers a new domain

Request

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

Security
authorization_code_with_pkce or client_credentials
Bodyapplication/json

The domain registration request.

domainstringrequired

The domain name to register.

application/json
{
  "domain": "string"
}

Responses

Created

Bodyapplication/json
domainstringrequired

The domain name (e.g. "example.com").

Example: "aritma.com"
statusstringrequired

The current verification status of the domain.

Enum"NotRegistered""Pending""Confirmed"
Example: "Pending"
verificationTokenstring or null

A DNS TXT token that must be published to verify ownership of the domain. Removed once verified.

Example: "aritma-verify-00000000-0000-0000-0000-000000000000"
Response
application/json
{
  "domain": "aritma.com",
  "status": "Pending",
  "verificationToken": "aritma-verify-00000000-0000-0000-0000-000000000000"
}

Unregisters a domain

Request

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

Security
authorization_code_with_pkce or client_credentials
Query
domainstring

The domain

No request payload

Responses

No Content

Response
No content

Gets status of a specific domain

Request

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

Security
authorization_code_with_pkce or client_credentials
Query
domainstring

The domain

No request payload

Responses

OK

Bodyapplication/json
domainstringrequired

The domain name (e.g. "example.com").

Example: "aritma.com"
statusstringrequired

The current verification status of the domain.

Enum"NotRegistered""Pending""Confirmed"
Example: "Pending"
verificationTokenstring or null

A DNS TXT token that must be published to verify ownership of the domain. Removed once verified.

Example: "aritma-verify-00000000-0000-0000-0000-000000000000"
Response
application/json
{
  "domain": "aritma.com",
  "status": "Pending",
  "verificationToken": "aritma-verify-00000000-0000-0000-0000-000000000000"
}

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

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