Skip to content
/Policies

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

Creates a new policy

Request

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

The policy request

subjectstringnon-emptyrequired
scopestring(uri)required
actionstringnon-emptyrequired
{
  "subject": "string",
  "scope": "http://example.com",
  "action": "string"
}

Responses

OK

Bodyapplication/json
subjectstringrequired
scopestringrequired
actionstringrequired
tenantstringrequired
Response
application/json
{
  "subject": "string",
  "scope": "string",
  "action": "string",
  "tenant": "string"
}

Deletes a policy

Request

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

The policy request

subjectstringnon-emptyrequired
scopestring(uri)required
actionstringnon-emptyrequired
{
  "subject": "string",
  "scope": "http://example.com",
  "action": "string"
}

Responses

No Content

Response
No content

Finds policies that matches a request filter

Request

Requires the requesting party to have read access on the requested scope

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
pageSizeinteger(int32)
cursorstring
includeDerivedboolean
includeInheritedboolean
subjectstring
scopestring(uri)
actionstring
No request payload

Responses

OK

Bodyapplication/json
policiesArray of objects(PolicyDto)required
subjectstringrequired
scopestringrequired
actionstringrequired
tenantstringrequired
cursorstring or null
Response
application/json
{
  "policies": [
    { … }
  ],
  "cursor": "string"
}

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