# Aritma IAM API An API for interacting with the identity and access management system of Aritma. Version: 0 ## Servers IAM API (0) ``` https://api.dev.aritma.io/core/iam ``` ## Security ### authorization_code_with_pkce_0 Type: oauth2 ### client_credentials_0 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. - [GET /v0/actions](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/actions/listactions.md) ## Client Actions related to clients in Aritma ID ### Returns a paginated list of available clients, optionally filtered by a query - [GET /v0/clients](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/paths/~1v0~1clients/get.md) ### Creates a client - [POST /v0/clients](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/paths/~1v0~1clients/post.md) ### Returns a client by clientId - [GET /v0/clients/{clientId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/paths/~1v0~1clients~1%7Bclientid%7D/get.md) ### Updates a client - [PUT /v0/clients/{clientId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/paths/~1v0~1clients~1%7Bclientid%7D/put.md) ### Deletes a client by ID - [DELETE /v0/clients/{clientId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/paths/~1v0~1clients~1%7Bclientid%7D/delete.md) ### Returns a paginated list of client secrets belonging to a client - [GET /v0/clients/{clientId}/secrets](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/paths/~1v0~1clients~1%7Bclientid%7D~1secrets/get.md) ### Creates a new secret for a client - [POST /v0/clients/{clientId}/secrets](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/paths/~1v0~1clients~1%7Bclientid%7D~1secrets/post.md) ### Deletes a client secret - [DELETE /v0/clients/{clientId}/secrets/{clientSecretId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/client/paths/~1v0~1clients~1%7Bclientid%7D~1secrets~1%7Bclientsecretid%7D/delete.md) ## Domains Actions related to domains registered for the tenant, and their verification status ### Gets registered domains - [GET /v0/domains](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/domains/getdomains.md) ### Registers a new domain - [POST /v0/domains](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/domains/createdomain.md) ### Deletes a domain - [DELETE /v0/domains](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/domains/deletedomain.md) ### Gets status of a specific domain - [GET /v0/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 /v0/me](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/me/paths/~1v0~1me/get.md) ### Returns an unpaginated list of all claims assigned to you - [GET /v0/me/claims](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/me/paths/~1v0~1me~1claims/get.md) ### Gets permission for currently authenticated user - [GET /v0/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 /v0/me/roles](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/me/paths/~1v0~1me~1roles/get.md) ## Policies Actions related to IAM policies ### Creates a new policy - [POST /v0/policies](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/policies/createpolicy.md) ### Deletes a policy - [DELETE /v0/policies](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/policies/removepolicy.md) ### Finds policies that matches a request filter - [GET /v0/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 /v0/role](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/role/paths/~1v0~1role/get.md) ## Scim Actions related to SCIM tokens ### Creates a SCIM token, must be connected to an SSO Provider - [POST /v0/scim](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/scim/paths/~1v0~1scim/post.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 /v0/scim](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/scim/paths/~1v0~1scim/get.md) ### Deletes a SCIM token by id - [DELETE /v0/scim/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/scim/paths/~1v0~1scim~1%7Bid%7D/delete.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 /v0/scopes](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/scope/paths/~1v0~1scopes/get.md) ## SSO Actions common for all SSO providers ### Lists registered SSO providers - [GET /v0/sso](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso/paths/~1v0~1sso/get.md) ## SSO - Azure AD (Entra ID) Actions relating to AzureAd as an SSO provider ### Creates a new SSO provider - [POST /v0/sso/azuread](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-azure-ad-(entra-id)/paths/~1v0~1sso~1azuread/post.md) ### Gets an SSO provider by id - [GET /v0/sso/azuread/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-azure-ad-(entra-id)/paths/~1v0~1sso~1azuread~1%7Bid%7D/get.md) ### Updates an SSO provider - [PUT /v0/sso/azuread/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-azure-ad-(entra-id)/paths/~1v0~1sso~1azuread~1%7Bid%7D/put.md) ### Deletes an SSO provider by id - [DELETE /v0/sso/azuread/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-azure-ad-(entra-id)/paths/~1v0~1sso~1azuread~1%7Bid%7D/delete.md) ## SSO - Custom Providers Actions relating to custom SSO providers ### Creates a new SSO provider - [POST /v0/sso/custom](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/paths/~1v0~1sso~1custom/post.md) ### Deletes an SSO provider by id - [DELETE /v0/sso/custom/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/paths/~1v0~1sso~1custom~1%7Bid%7D/delete.md) ### Gets an SSO provider by id - [GET /v0/sso/custom/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/paths/~1v0~1sso~1custom~1%7Bid%7D/get.md) ### Updates an SSO provider - [PUT /v0/sso/custom/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/paths/~1v0~1sso~1custom~1%7Bid%7D/put.md) ### Updates the icon for a custom SSO provider - [PUT /v0/sso/custom/{id}/icon](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/paths/~1v0~1sso~1custom~1%7Bid%7D~1icon/put.md) ### Removes an icon from a custom identityProvider - [DELETE /v0/sso/custom/{id}/icon](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-custom-providers/paths/~1v0~1sso~1custom~1%7Bid%7D~1icon/delete.md) ## SSO - Google Actions relating to Google as an SSO provider ### Creates a new SSO provider - [POST /v0/sso/google](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-google/paths/~1v0~1sso~1google/post.md) ### Gets an SSO provider by id - [GET /v0/sso/google/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-google/paths/~1v0~1sso~1google~1%7Bid%7D/get.md) ### Updates an SSO provider - [PUT /v0/sso/google/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-google/paths/~1v0~1sso~1google~1%7Bid%7D/put.md) ### Deletes an SSO provider by id - [DELETE /v0/sso/google/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-google/paths/~1v0~1sso~1google~1%7Bid%7D/delete.md) ## SSO - Signicat Actions relating to Signicat as an SSO provider ### Creates a new SSO provider - [POST /v0/sso/signicat](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-signicat/paths/~1v0~1sso~1signicat/post.md) ### Gets an SSO provider by id - [GET /v0/sso/signicat/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-signicat/paths/~1v0~1sso~1signicat~1%7Bid%7D/get.md) ### Updates an SSO provider - [PUT /v0/sso/signicat/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-signicat/paths/~1v0~1sso~1signicat~1%7Bid%7D/put.md) ### Deletes an SSO provider by id - [DELETE /v0/sso/signicat/{id}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/sso-signicat/paths/~1v0~1sso~1signicat~1%7Bid%7D/delete.md) ## Subjects Actions related to IAM subjects ### Gets subjects of all types - [GET /v0/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 /v0/subjects/{subject}/memberships](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getsubjectmemberships.md) ### Gets the permissions of a subject - [GET /v0/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 /v0/subjects/clients](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getclientsubjects.md) ### Gets the permissions of a client - [GET /v0/subjects/clients/{clientId}/permissions](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getclientpermissions.md) ### Gets subject groups - [GET /v0/subjects/groups](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getsubjectgroups.md) ### Creates a new subject group - [POST /v0/subjects/groups](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/createsubjectgroup.md) ### Deletes a subject group - [DELETE /v0/subjects/groups/{groupId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/deletesubjectgroup.md) ### Gets the permissions of a group - [GET /v0/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 /v0/subjects/groups/{groupSubjectId}/members](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/paths/~1v0~1subjects~1groups~1%7Bgroupsubjectid%7D~1members/get.md) ### Adds a member to a subject group - [POST /v0/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 /v0/subjects/groups/{groupSubjectId}/members](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/removesubjectfromsubjectgroup.md) ### Gets user subjects - [GET /v0/subjects/users](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/subjects/getusersubjects.md) ### Gets the permissions of a user - [GET /v0/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 /v0/users](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/paths/~1v0~1users/get.md) ### Returns a user by their id - [GET /v0/users/{userId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/paths/~1v0~1users~1%7Buserid%7D/get.md) ### Assigns a role to a user - [POST /v0/users/{userId}/role/{roleId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/paths/~1v0~1users~1%7Buserid%7D~1role~1%7Broleid%7D/post.md) ### Removes a role from a user - [DELETE /v0/users/{userId}/role/{roleId}](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/paths/~1v0~1users~1%7Buserid%7D~1role~1%7Broleid%7D/delete.md) ### Sends an invitation to Aritma ID - [POST /v0/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 /v0/users/users](https://developer.aritma.com/apis/platform/iam/openapi/iam-openapi/user/createusersubject.md)