Skip to content
/Me

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

Gets information about the user

Request

Allowed subject types: User only. Requests from other subject types are rejected with 400 Bad Request.

Security
authorization_code_with_pkce or client_credentials
No request payload

Responses

OK

Bodyapplication/json
idstringrequired

The unique identifier of the user.

Example: "00000000-0000-0000-0000-000000000001"
userNamestringrequired

The username (login name) of the user.

Example: "jane.doe@aritma.com"
emailstringrequired

The email address of the user.

Example: "jane.doe@aritma.com"
phoneNumberstringrequired

The phone number of the user, if registered.

Example: "+4712345678"
twoFactorEnabledbooleanrequired

Indicates whether two-factor authentication is enabled for the user.

Example: false
rolesArray of objects(RoleDto)required

The roles assigned to the user.

idstringrequired

The unique identifier of the role.

namestringrequired

The name of the role.

Response
application/json
{
  "id": "00000000-0000-0000-0000-000000000001",
  "userName": "jane.doe@aritma.com",
  "email": "jane.doe@aritma.com",
  "phoneNumber": "+4712345678",
  "twoFactorEnabled": false,
  "roles": [
    { … }
  ]
}

Returns an unpaginated list of all roles assigned to you

Request

Allowed subject types: User only. Requests from other subject types are rejected with 400 Bad Request.

Security
authorization_code_with_pkce or client_credentials
No request payload

Responses

OK

Bodyapplication/jsonArray [
idstringrequired

The unique identifier of the role.

namestringrequired

The name of the role.

]
Response
application/json
[
  {
    "id": "string",
    "name": "string"
  }
]

Returns an unpaginated list of all claims assigned to you

Request

Allowed subject types: User only. Requests from other subject types are rejected with 400 Bad Request.

Security
authorization_code_with_pkce or client_credentials
No request payload

Responses

OK

Bodyapplication/jsonArray [
claimIdinteger(int32)required

The internal claim identifier.

Example: 42
userIdstringrequired

The user the claim belongs to.

Example: "00000000-0000-0000-0000-000000000001"
claimTypestringrequired

The claim type (e.g. a URI or short name).

Example: "email"
claimValuestringrequired

The claim value.

Example: "user@aritma.com"
]
Response
application/json
[
  {
    "claimId": 42,
    "userId": "00000000-0000-0000-0000-000000000001",
    "claimType": "email",
    "claimValue": "user@aritma.com"
  }
]

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