Skip to content
/Domains

Aritma IAM API (0)

An API for interacting with the identity and access management system of Aritma.

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
IAM API (0)
https://api.dev.aritma.io/core/iam

Actions

Actions related to IAM actions

Operations

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

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
filterstring

The string used to filter the request

No request payload

Responses

OK

Body
Array [
domainstringrequired
statusstringrequired
Enum"NotRegistered""Pending""Confirmed"
verificationTokenstring or null
]
Response
No response example

Registers a new domain

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
domainstring

The domain

No request payload

Responses

OK

Body
domainstringrequired
statusstringrequired
Enum"NotRegistered""Pending""Confirmed"
verificationTokenstring or null
Response
No response example

Deletes a domain

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
domainstring

The domain

No request payload

Responses

No Content

Body
domainstringrequired
statusstringrequired
Enum"NotRegistered""Pending""Confirmed"
verificationTokenstring or null
Response
No response example

Gets status of a specific domain

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
domainstring

The domain

No request payload

Responses

OK

Body
domainstringrequired
statusstringrequired
Enum"NotRegistered""Pending""Confirmed"
verificationTokenstring or null
Response
No response example

Me

Actions listing information about the currently authenticated user

Operations

Policies

Actions related to IAM policies

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

Subjects

Actions related to IAM subjects

Operations

User

Actions related to Aritma ID users

Operations