Skip to content
API Reference
/
/
Sends an invitation to Ar...

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

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

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

Request

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

Search query

pageinteger(int32)

Requested page

pageSizeinteger(int32)

Requested pagesize

No request payload

Responses

OK

Body
itemsArray of objects(UserDto)required
items[].​idstringrequired
items[].​userNamestringrequired
items[].​emailstringrequired
items[].​phoneNumberstringrequired
items[].​twoFactorEnabledbooleanrequired
items[].​rolesArray of objects(RoleDto)required
items[].​roles[].​idstringrequired
items[].​roles[].​namestringrequired
metadataobjectrequired
metadata.​pageinteger(int32)required
metadata.​pageSizeinteger(int32)required
metadata.​totalCountinteger(int32)required
linksobjectrequired
links.​firststring or null(uri)
links.​previousstring or null(uri)
links.​nextstring or null(uri)
links.​laststring or null(uri)
Response
No response example

Returns a user by their id

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Path
userIdstringrequired
No request payload

Responses

OK

Body
idstringrequired
userNamestringrequired
emailstringrequired
phoneNumberstringrequired
twoFactorEnabledbooleanrequired
rolesArray of objects(RoleDto)required
roles[].​idstringrequired
roles[].​namestringrequired
Response
No response example

Assigns a role to a user

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Path
userIdstringrequired
roleIdstringrequired
No request payload

Responses

OK

Response
No content

Removes a role from a user

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Path
userIdstringrequired
roleIdstringrequired
No request payload

Responses

OK

Response
No content

Sends an invitation to Aritma ID

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
emailstring
redirectUrlstring
No request payload

Responses

No Content

Creates a user subject if their domain is verified.

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
emailstring
fullNamestring
phoneNumberstring
No request payload

Responses

OK

Body
userIdstringrequired
emailstringrequired
phoneNumberstringrequired
fullNamestringrequired
Response
No response example