Skip to content
API Reference
/
/
Returns a user by their i...

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

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

Returns a paginated list of users, optionally filtered by a search query

Request

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

Security
authorization_code_with_pkce or client_credentials
Query
searchTextstring

Search query

pageinteger(int32)

Requested page

pageSizeinteger(int32)

Requested pagesize

No request payload

Responses

OK

Bodyapplication/json
itemsArray of objects(UserDto)required

The items on the current page.

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.

metadataobjectrequired

Pagination details such as current page, page size, and total count.

pageinteger(int32)required

The current page number (1-based).

pageSizeinteger(int32)required

The number of items per page.

totalCountinteger(int32)required

The total number of items across all pages.

linksobjectrequired

Navigation links for first, previous, next, and last pages.

firststring or null(uri)

Link to the first page.

previousstring or null(uri)

Link to the previous page, if one exists.

nextstring or null(uri)

Link to the next page, if one exists.

laststring or null(uri)

Link to the last page.

Response
application/json
{
  "items": [
    { … }
  ],
  "metadata": {
    "page": 0,
    "pageSize": 0,
    "totalCount": 0
  },
  "links": {
    "first": "http://example.com",
    "previous": "http://example.com",
    "next": "http://example.com",
    "last": "http://example.com"
  }
}

Returns a user by their id

Request

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

Security
authorization_code_with_pkce or client_credentials
Path
userIdstringrequired

The user's unique identifier.

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": [
    { … }
  ]
}

Assigns a role to a user

Request

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

Security
authorization_code_with_pkce or client_credentials
Path
userIdstringrequired

The user's unique identifier.

roleIdstringrequired

The role's unique identifier.

No request payload

Responses

OK

Response
No content

Removes a role from a user

Request

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

Security
authorization_code_with_pkce or client_credentials
Path
userIdstringrequired

The user's unique identifier.

roleIdstringrequired

The role's unique identifier.

No request payload

Responses

OK

Response
No content

Creates a user subject if their domain is verified.

Request

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

Security
authorization_code_with_pkce or client_credentials
Bodyapplication/json

Details of the user to create.

emailstringrequired

The email address for the new user.

Example: "jane.doe@example.com"
fullNamestringrequired

The full name of the new user.

Example: "Jane Doe"
phoneNumberstringrequired

The phone number of the new user.

Example: "+4712345678"
application/json
{
  "email": "jane.doe@example.com",
  "fullName": "Jane Doe",
  "phoneNumber": "+4712345678"
}

Responses

OK

Bodyapplication/json
userIdstringrequired

The unique identifier of the newly created user.

Example: "00000000-0000-0000-0000-000000000001"
emailstringrequired

The email address of the newly created user.

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

The phone number of the newly created user.

Example: "+4712345678"
fullNamestringrequired

The full name of the newly created user.

Example: "Jane Doe"
Response
application/json
{
  "userId": "00000000-0000-0000-0000-000000000001",
  "email": "jane.doe@aritma.com",
  "phoneNumber": "+4712345678",
  "fullName": "Jane Doe"
}