Skip to content
/Actions

Aritma IAM API (V1)

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
https://api.dev.aritma.io/core/iam

Actions

Actions related to IAM actions

Operations

Returns a list of all available actions, including their display names, description and names of their immediate children.

Request

Security
authorization_code_with_pkce(Required scopes:
services.iam
) or client_credentials(Required scopes:
services.iam
)
Headers
Accept-Languagestring

Preferred response locale

Default en
Enum"en""nb-NO"
No request payload

Responses

OK

Bodyapplication/jsonArray [
idstringrequired

The unique action identifier used in policy definitions.

Example: "iam.policy.write"
displayNamestringrequired

A human-readable name for the action.

Example: "Read policies"
descriptionstringrequired

A short description of what this action grants access to.

Example: "Grants read access to IAM policies within the authorized scope."
childrenArray of objects(ActionChildDto)required

Immediate child actions nested under this action.

Example: [{"id":"iam.policy.write"}]
idstringrequired

The unique action identifier.

Example: "iam.policy.write"
typestringrequired

Whether this child is a role or an action. A role has children whilst an action does not.

typestringrequired

Whether the action is a role action or application action

]
Response
application/json
[
  {
    "id": "iam.policy.write",
    "displayName": "Read policies",
    "description": "Grants read access to IAM policies within the authorized scope.",
    "children": [ … ]
  }
]

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