Organization roles

Create an organization role

Create a new organization role with the given data.

post/api/organization-roles

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/organization-roles
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Request body

tenantIdstring
namestring required

The name of the organization role. It must be unique within the organization template.

descriptionstring nullable

The description of the organization role.

type'User' | 'MachineToMachine'
organizationScopeIdsstring[] required

An array of organization scope IDs to be assigned to the organization role.

resourceScopeIdsstring[] required

An array of resource scope IDs to be assigned to the organization role.

Response

The organization role was created successfully.

tenantIdstring required
idstring required
namestring required
descriptionstring nullable required
type'User' | 'MachineToMachine' required

Changes

No recorded changes to this operation across all 8 revisions of this API.