Skip to content
API Reference
/
/
Creates an invitation for...

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

Creates an invitation for a new user. An invitation email is sent with a link to complete registration. For each requested permission, the caller must have "iam.policy.write" over the requested scope.

Request

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

Security
authorization_code_with_pkce or client_credentials
Bodyapplication/json
emailstringrequired

Email address to invite.

Example: "jane.doe@example.com"
permissionsArray of objects(InvitationPermissionRequest)required

IAM permissions to grant when the invitation is accepted.

actionstringrequired

IAM action, e.g. "tenant.subjects.manage".

scopestringrequired

Resource URI scope the action applies to.

ttlDaysinteger(int32)required

Number of days until the invitation expires. Defaults to 7.

redirectUristring or null

URI to redirect the invitee to after they finish registering. Null means no redirect.

application/json
{
  "email": "jane.doe@example.com",
  "permissions": [
    { … }
  ],
  "ttlDays": 0,
  "redirectUri": "string"
}

Responses

Created

Bodyapplication/json
idstring(uuid)required
emailstringrequired
statusstringrequired
Enum"Pending""PendingEnrollment""Processing""Accepted""Cancelled""Expired"
createdAtstring(date-time)required
expiresAtstring(date-time)required
acceptedAtstring or null(date-time)
permissionsArray of objects(InvitationPermissionDto)required
actionstringrequired
scopestringrequired
redirectUristring or null
inviterNamestring or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string",
  "status": "Pending",
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "acceptedAt": "2019-08-24T14:15:22Z",
  "permissions": [
    { … }
  ],
  "redirectUri": "string",
  "inviterName": "string"
}

Returns a paginated list of invitations for the current tenant.

Request

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

Security
authorization_code_with_pkce or client_credentials
Query
statusstring
Enum"Pending""PendingEnrollment""Processing""Accepted""Cancelled""Expired"
pageinteger(int32)

Requested page

pageSizeinteger(int32)

Requested pagesize

No request payload

Responses

OK

Bodyapplication/json
itemsArray of objects(InvitationDto)required

The items on the current page.

idstring(uuid)required
emailstringrequired
statusstringrequired
Enum"Pending""PendingEnrollment""Processing""Accepted""Cancelled""Expired"
createdAtstring(date-time)required
expiresAtstring(date-time)required
acceptedAtstring or null(date-time)
permissionsArray of objects(InvitationPermissionDto)required
actionstringrequired
scopestringrequired
redirectUristring or null
inviterNamestring or null
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 single invitation by id.

Request

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

Security
authorization_code_with_pkce or client_credentials
Path
idstring(uuid)required
No request payload

Responses

OK

Bodyapplication/json
idstring(uuid)required
emailstringrequired
statusstringrequired
Enum"Pending""PendingEnrollment""Processing""Accepted""Cancelled""Expired"
createdAtstring(date-time)required
expiresAtstring(date-time)required
acceptedAtstring or null(date-time)
permissionsArray of objects(InvitationPermissionDto)required
actionstringrequired
scopestringrequired
redirectUristring or null
inviterNamestring or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string",
  "status": "Pending",
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "acceptedAt": "2019-08-24T14:15:22Z",
  "permissions": [
    { … }
  ],
  "redirectUri": "string",
  "inviterName": "string"
}

Cancels a pending invitation.

Request

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

Security
authorization_code_with_pkce or client_credentials
Path
idstring(uuid)required
No request payload

Responses

OK

Bodyapplication/json
idstring(uuid)required
emailstringrequired
statusstringrequired
Enum"Pending""PendingEnrollment""Processing""Accepted""Cancelled""Expired"
createdAtstring(date-time)required
expiresAtstring(date-time)required
acceptedAtstring or null(date-time)
permissionsArray of objects(InvitationPermissionDto)required
actionstringrequired
scopestringrequired
redirectUristring or null
inviterNamestring or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string",
  "status": "Pending",
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "acceptedAt": "2019-08-24T14:15:22Z",
  "permissions": [
    { … }
  ],
  "redirectUri": "string",
  "inviterName": "string"
}

Resends the invitation email and resets the expiry. Only valid for pending invitations. For each requested permission, the caller must have "iam.policy.write" over the requested scope.

Request

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

Security
authorization_code_with_pkce or client_credentials
Path
idstring(uuid)required
Query
ttlDaysinteger(int32)
No request payload

Responses

OK

Bodyapplication/json
idstring(uuid)required
emailstringrequired
statusstringrequired
Enum"Pending""PendingEnrollment""Processing""Accepted""Cancelled""Expired"
createdAtstring(date-time)required
expiresAtstring(date-time)required
acceptedAtstring or null(date-time)
permissionsArray of objects(InvitationPermissionDto)required
actionstringrequired
scopestringrequired
redirectUristring or null
inviterNamestring or null
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string",
  "status": "Pending",
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "acceptedAt": "2019-08-24T14:15:22Z",
  "permissions": [
    { … }
  ],
  "redirectUri": "string",
  "inviterName": "string"
}

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