# Aritma IAM API

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

Version: V1

## Servers

IAM API
```
https://api.dev.aritma.io/core/iam
```

## Security

### authorization_code_with_pkce

Type: oauth2

### client_credentials

Type: oauth2

## Download OpenAPI description

[Aritma IAM API](https://developer.aritma.com/_bundle/apis/platform/iam/openapi/iam-openapi.yaml)

## Actions

Actions related to IAM actions

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

 - [GET /v1/actions](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/actions/listfullactions.md)

## Client

Actions related to clients in Aritma ID

### Returns a paginated list of available clients, optionally filtered by a query

 - [GET /v1/clients](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/getclients.md)

### Creates a client

 - [POST /v1/clients](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/createclient.md)

### Returns a client by clientId

 - [GET /v1/clients/{clientId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/getclientbyclientid.md)

### Updates a client

 - [PUT /v1/clients/{clientId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/updateclient.md)

### Deletes a client by ID

 - [DELETE /v1/clients/{clientId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/deleteclient.md)

### Returns a paginated list of client secrets belonging to a client

 - [GET /v1/clients/{clientId}/secrets](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/getclientsecrets.md)

### Creates a new secret for a client

 - [POST /v1/clients/{clientId}/secrets](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/createclientsecret.md)

### Deletes a client secret

 - [DELETE /v1/clients/{clientId}/secrets/{clientSecretId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/deleteclientsecret.md)

## Domains

Actions related to domains registered for the tenant, and their verification status

### Gets registered domains

 - [GET /v1/domains](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/domains/getdomains.md)

### Registers a new domain

 - [POST /v1/domains](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/domains/registerdomain.md)

### Unregisters a domain

 - [DELETE /v1/domains](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/domains/unregisterdomain.md)

### Gets status of a specific domain

 - [GET /v1/domains/status](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/domains/getdomain.md)

## Me

Actions related to the currently authenticated user

### Gets information about the user

 - [GET /v1/me](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/me/getself.md)

### Returns an unpaginated list of all claims assigned to you

 - [GET /v1/me/claims](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/me/getuserclaims.md)

### Gets permissions for the currently authenticated user

 - [GET /v1/me/permissions](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/me/getownpermissions.md)

### Returns an unpaginated list of all roles assigned to you

 - [GET /v1/me/roles](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/me/getuserroles.md)

## Policies

Actions related to IAM policies

### Creates a new policy

 - [POST /v1/policies](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/policies/createpolicy.md)

### Deletes a policy

 - [DELETE /v1/policies](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/policies/removepolicy.md)

### Finds policies that matches a request filter

 - [GET /v1/policies](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/policies/findpolicies.md): Requires the requesting party to have read access on the requested scope

## Role

Actions related to Aritma ID roles

### Returns a paginated list of available roles that can be assigned to users, optionally filtered by a query

 - [GET /v1/role](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/role/getroles.md)

## Scim

Actions related to SCIM tokens

### Creates a SCIM token, must be connected to an SSO Provider

 - [POST /v1/scim](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/scim/createscimtoken.md): The SCIM token secret will only be showed in the response of this endpoint, it will never be shown again, so be sure to copy it.

### Lists all registered SCIM tokens

 - [GET /v1/scim](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/scim/listscimtokens.md)

### Deletes a SCIM token by id

 - [DELETE /v1/scim/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/scim/deletescimtoken.md)

## Scope

Actions related to scopes in Aritma ID

### Returns a paginated list of available scopes that can be assigned to clients, optionally filtered by a query

 - [GET /v1/scopes](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/scope/getscopes.md)

## SSO

Actions common for all SSO providers

### Lists registered SSO providers

 - [GET /v1/sso](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso/listidentityproviders.md)

## SSO - Azure AD (Entra ID)

Actions relating to AzureAd as an SSO provider

### Creates a new SSO provider

 - [POST /v1/sso/azuread](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-azure-ad-(entra-id)/azurecreateidentityprovider.md)

### Gets an SSO provider by id

 - [GET /v1/sso/azuread/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-azure-ad-(entra-id)/azuregetidentityprovider.md)

### Updates an SSO provider

 - [PUT /v1/sso/azuread/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-azure-ad-(entra-id)/azureupdateidentityprovider.md)

### Deletes an SSO provider by id

 - [DELETE /v1/sso/azuread/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-azure-ad-(entra-id)/azuredeleteidentityprovider.md)

## SSO - Custom Providers

Actions relating to custom SSO providers

### Creates a new SSO provider

 - [POST /v1/sso/custom](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/createidentityprovider.md)

### Deletes an SSO provider by id

 - [DELETE /v1/sso/custom/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/deleteidentityprovider.md)

### Gets an SSO provider by id

 - [GET /v1/sso/custom/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/customgetidentityprovider.md)

### Updates an SSO provider

 - [PUT /v1/sso/custom/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/customupdateidentityprovider.md)

### Updates the icon for a custom SSO provider

 - [PUT /v1/sso/custom/{id}/icon](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/updateprovidericon.md)

### Removes the icon from a custom SSO provider

 - [DELETE /v1/sso/custom/{id}/icon](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/deleteprovidericon.md)

## SSO - Google

Actions relating to Google as an SSO provider

### Creates a new SSO provider

 - [POST /v1/sso/google](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-google/googlecreateidentityprovider.md)

### Gets an SSO provider by id

 - [GET /v1/sso/google/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-google/googlegetidentityprovider.md)

### Updates an SSO provider

 - [PUT /v1/sso/google/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-google/googleupdateidentityprovider.md)

### Deletes an SSO provider by id

 - [DELETE /v1/sso/google/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-google/googledeleteidentityprovider.md)

## SSO - Signicat

Actions relating to Signicat as an SSO provider

### Creates a new SSO provider

 - [POST /v1/sso/signicat](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-signicat/signicatcreateidentityprovider.md)

### Gets an SSO provider by id

 - [GET /v1/sso/signicat/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-signicat/signicatgetidentityprovider.md)

### Updates an SSO provider

 - [PUT /v1/sso/signicat/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-signicat/signicatupdateidentityprovider.md)

### Deletes an SSO provider by id

 - [DELETE /v1/sso/signicat/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-signicat/signicatdeleteidentityprovider.md)

## Subjects

Actions related to IAM subjects

### Gets subjects of all types

 - [GET /v1/subjects](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getsubjects.md)

### List the groups of which a subject is a member of

 - [GET /v1/subjects/{subject}/memberships](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getsubjectmemberships.md)

### Gets the permissions of a subject

 - [GET /v1/subjects/{subject}/permissions](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getsubjectpermissions.md): The requesting party must have read access for a given scope to return it

### Gets client subjects

 - [GET /v1/subjects/clients](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getclientsubjects.md)

### Gets the permissions of a client

 - [GET /v1/subjects/clients/{clientId}/permissions](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getclientpermissions.md)

### Gets subject groups

 - [GET /v1/subjects/groups](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getsubjectgroups.md)

### Creates a new subject group

 - [POST /v1/subjects/groups](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/createsubjectgroup.md)

### Deletes a subject group

 - [DELETE /v1/subjects/groups/{groupId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/deletesubjectgroup.md)

### Gets the permissions of a group

 - [GET /v1/subjects/groups/{groupId}/permissions](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getgrouppermissions.md)

### Gets the subjects within a subject group

 - [GET /v1/subjects/groups/{groupSubjectId}/members](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getgroupsubjects.md)

### Adds a member to a subject group

 - [POST /v1/subjects/groups/{groupSubjectId}/members](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/addsubjectstosubjectgroup.md)

### Removes a member from a subject group

 - [DELETE /v1/subjects/groups/{groupSubjectId}/members](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/removesubjectfromsubjectgroup.md)

### Gets user subjects

 - [GET /v1/subjects/users](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getusersubjects.md)

### Gets the permissions of a user

 - [GET /v1/subjects/users/{userId}/permissions](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getuserpermissions.md)

## User

Actions related to Aritma ID users

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

 - [GET /v1/users](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/getusers.md)

### Returns a user by their id

 - [GET /v1/users/{userId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/getuser.md)

### Assigns a role to a user

 - [POST /v1/users/{userId}/role/{roleId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/assignroletouser.md)

### Removes a role from a user

 - [DELETE /v1/users/{userId}/role/{roleId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/removerolefromuser.md)

### Sends an invitation to Aritma ID

 - [POST /v1/users/invite](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/inviteusersubject.md)

### Creates a user subject if their domain is verified.

 - [POST /v1/users/users](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/createusersubject.md)