Replace organization scopes for organization role

PUT /api/organization-roles/{id}/scopes

Replace all organization scopes that are assigned to the specified organization role with the given organization scopes. This effectively removes all existing organization scope assignments and replaces them with the new ones.

Path parameters

  • id string Required

    The unique identifier of the organization role.

application/json

Body Required

  • organizationScopeIds array[string] Required

    An array of organization scope IDs to replace existing scopes.

    Minimum length of each is 1.

Responses

  • 204

    Organization scopes were replaced successfully.

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 422

    At least one of the IDs provided is invalid. For example, the organization scope ID does not exist.

PUT /api/organization-roles/{id}/scopes
curl \
 -X PUT https://[tenant_id].logto.app/api/organization-roles/{id}/scopes \
 -H "Content-Type: application/json" \
 -d '{"organizationScopeIds":["string"]}'
Request example
{
  "organizationScopeIds": [
    "string"
  ]
}