Skip to content
API Reference
/
/
Gets subject groups

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

Gets subjects of all types

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
searchQuerystring
pageinteger(int32)
pageSizeinteger(int32)
No request payload

Responses

OK

Bodyapplication/json
dataArray of objects(SubjectDto)required
data[].​idstringrequired
data[].​displayNamestringrequired
data[].​tenantstring or null
data[].​subjectIdstringread-onlyrequired
data[].​typestringread-onlyrequired
Enum"User""Client""Anonymous""Group"
data[].​propertiesanyread-onlyrequired
pageinteger(int32)required
pageSizeinteger(int32)required
countinteger(int32)read-onlyrequired
totalinteger(int32)required
totalPagesinteger(int32)read-onlyrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "page": 0,
  "pageSize": 0,
  "count": 0,
  "total": 0,
  "totalPages": 0
}

List the groups of which a subject is a member of

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Path
subjectstringrequired
Query
pageinteger(int32)
pageSizeinteger(int32)
No request payload

Responses

OK

Bodyapplication/json
dataArray of objects(SubjectGroupDto)required
data[].​idstringrequired
data[].​displayNamestringrequired
data[].​tenantstring or null
data[].​subjectIdstringread-onlyrequired
data[].​typestringread-onlyrequired
Enum"User""Client""Anonymous""Group"
data[].​propertiesobjectrequired
data[].​properties.​descriptionstringrequired
data[].​properties.​memberCountinteger(int32)required
pageinteger(int32)required
pageSizeinteger(int32)required
countinteger(int32)read-onlyrequired
totalinteger(int32)required
totalPagesinteger(int32)read-onlyrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "page": 0,
  "pageSize": 0,
  "count": 0,
  "total": 0,
  "totalPages": 0
}

Gets the permissions of a subject

Request

The requesting party must have read access for a given scope to return it

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

The subject id

Query
resourceTypestring
resourceProviderstring
actionstring
No request payload

Responses

OK

Bodyapplication/json
policiesArray of objects(PolicyDto)required
policies[].​subjectstringrequired
policies[].​scopestringrequired
policies[].​actionstringrequired
policies[].​tenantstringrequired
tenantRolesArray of stringsrequired
subjectstringrequired
Response
application/json
{
  "policies": [
    { … }
  ],
  "tenantRoles": [
    "string"
  ],
  "subject": "string"
}

Gets client subjects

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
searchQuerystring
pageinteger(int32)
pageSizeinteger(int32)
No request payload

Responses

OK

Bodyapplication/json
dataArray of objects(ClientSubjectDto)required
data[].​idstringrequired
data[].​displayNamestringrequired
data[].​tenantstring or null
data[].​subjectIdstringread-onlyrequired
data[].​typestringread-onlyrequired
Enum"User""Client""Anonymous""Group"
data[].​propertiesobjectrequired
data[].​properties.​iconUristringrequired
data[].​properties.​descriptionstringrequired
pageinteger(int32)required
pageSizeinteger(int32)required
countinteger(int32)read-onlyrequired
totalinteger(int32)required
totalPagesinteger(int32)read-onlyrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "page": 0,
  "pageSize": 0,
  "count": 0,
  "total": 0,
  "totalPages": 0
}

Gets the permissions of a client

Request

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

The client id

Query
resourceTypestring
resourceProviderstring
actionstring
No request payload

Responses

OK

Bodyapplication/json
policiesArray of objects(PolicyDto)required
policies[].​subjectstringrequired
policies[].​scopestringrequired
policies[].​actionstringrequired
policies[].​tenantstringrequired
tenantRolesArray of stringsrequired
subjectstringrequired
Response
application/json
{
  "policies": [
    { … }
  ],
  "tenantRoles": [
    "string"
  ],
  "subject": "string"
}

Gets subject groups

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
searchQuerystring
pageinteger(int32)
pageSizeinteger(int32)
No request payload

Responses

OK

Bodyapplication/json
dataArray of objects(SubjectGroupDto)required
data[].​idstringrequired
data[].​displayNamestringrequired
data[].​tenantstring or null
data[].​subjectIdstringread-onlyrequired
data[].​typestringread-onlyrequired
Enum"User""Client""Anonymous""Group"
data[].​propertiesobjectrequired
data[].​properties.​descriptionstringrequired
data[].​properties.​memberCountinteger(int32)required
pageinteger(int32)required
pageSizeinteger(int32)required
countinteger(int32)read-onlyrequired
totalinteger(int32)required
totalPagesinteger(int32)read-onlyrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "page": 0,
  "pageSize": 0,
  "count": 0,
  "total": 0,
  "totalPages": 0
}

Creates a new subject group

Request

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

Group creation parameters

displayNamestringrequired
descriptionstringrequired
{
  "displayName": "string",
  "description": "string"
}

Responses

OK

Bodyapplication/json
idstringrequired
displayNamestringrequired
tenantstring or null
subjectIdstringread-onlyrequired
typestringread-onlyrequired
Enum"User""Client""Anonymous""Group"
propertiesobjectrequired
properties.​descriptionstringrequired
properties.​memberCountinteger(int32)required
Response
application/json
{
  "id": "string",
  "displayName": "string",
  "tenant": "string",
  "subjectId": "string",
  "type": "User",
  "properties": {
    "description": "string",
    "memberCount": 0
  }
}

Deletes a subject group

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Path
groupIdstring(uuid)required

The id of the subject group

No request payload

Responses

No Content

Response
No content

Gets the permissions of a group

Request

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

The group id

Query
resourceTypestring
resourceProviderstring
actionstring
No request payload

Responses

OK

Bodyapplication/json
policiesArray of objects(PolicyDto)required
policies[].​subjectstringrequired
policies[].​scopestringrequired
policies[].​actionstringrequired
policies[].​tenantstringrequired
tenantRolesArray of stringsrequired
subjectstringrequired
Response
application/json
{
  "policies": [
    { … }
  ],
  "tenantRoles": [
    "string"
  ],
  "subject": "string"
}

Gets the subjects within a subject group

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Path
groupSubjectIdstring(uuid)required

The id of the subject group

Query
pageinteger(int32)
pageSizeinteger(int32)
No request payload

Responses

OK

Bodyapplication/json
dataArray of objects(SubjectDto)required
data[].​idstringrequired
data[].​displayNamestringrequired
data[].​tenantstring or null
data[].​subjectIdstringread-onlyrequired
data[].​typestringread-onlyrequired
Enum"User""Client""Anonymous""Group"
data[].​propertiesanyread-onlyrequired
pageinteger(int32)required
pageSizeinteger(int32)required
countinteger(int32)read-onlyrequired
totalinteger(int32)required
totalPagesinteger(int32)read-onlyrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "page": 0,
  "pageSize": 0,
  "count": 0,
  "total": 0,
  "totalPages": 0
}

Adds a member to a subject group

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Path
groupSubjectIdstring(uuid)required

The id of the subject group

Body

The mutation request

subjectIdsArray of stringsrequired
{
  "subjectIds": [
    "string"
  ]
}

Responses

OK

Bodyapplication/jsonArray [
groupIdstring or null(uuid)
groupobject or null
subjectIdstringrequired
]
Response
application/json
[
  {
    "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
    "group": { … },
    "subjectId": "string"
  }
]

Removes a member from a subject group

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Path
groupSubjectIdstring(uuid)required

The id of the subject group

Body

The mutation request

subjectIdsArray of stringsrequired
{
  "subjectIds": [
    "string"
  ]
}

Responses

No Content

Response
No content

Gets user subjects

Request

Security
authorization_code_with_pkce_0(Required scopes:
services.iam
) or client_credentials_0(Required scopes:
services.iam
)
Query
searchQuerystring
pageinteger(int32)
pageSizeinteger(int32)
No request payload

Responses

OK

Bodyapplication/json
dataArray of objects(UserSubjectDto)required
data[].​idstringrequired
data[].​displayNamestringrequired
data[].​tenantstring or null
data[].​subjectIdstringread-onlyrequired
data[].​typestringread-onlyrequired
Enum"User""Client""Anonymous""Group"
data[].​propertiesobjectrequired
data[].​properties.​usernamestringrequired
data[].​properties.​emailstringrequired
data[].​properties.​phoneNumberstringrequired
pageinteger(int32)required
pageSizeinteger(int32)required
countinteger(int32)read-onlyrequired
totalinteger(int32)required
totalPagesinteger(int32)read-onlyrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "page": 0,
  "pageSize": 0,
  "count": 0,
  "total": 0,
  "totalPages": 0
}

Gets the permissions of a user

Request

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

The user id

Query
resourceTypestring
resourceProviderstring
actionstring
No request payload

Responses

OK

Bodyapplication/json
policiesArray of objects(PolicyDto)required
policies[].​subjectstringrequired
policies[].​scopestringrequired
policies[].​actionstringrequired
policies[].​tenantstringrequired
tenantRolesArray of stringsrequired
subjectstringrequired
Response
application/json
{
  "policies": [
    { … }
  ],
  "tenantRoles": [
    "string"
  ],
  "subject": "string"
}

User

Actions related to Aritma ID users

Operations