Sign in
Config API

List Roles

Changed on

List all Roles

get/api/configs/role

Request

  • The document declares no server URL.
  • Auth: none declared

Response

Successful Response

namestring required
descriptionstring required
immutableboolean
sync_mode'force' | 'import' | 'ignore'

Sync mode for role assignments.

  • FORCE: Add from matching IDP claims and remove the IDP-derived assignment on the next human request without a matching claim.
  • IMPORT: Add from matching IDP claims and retain the assignment (default).
  • IGNORE: Never synchronize this role from IDP claims; manage it manually.
external_rolesstring[] nullable

Changes

  • a8157dc3279dRevision changes
    • ▲

      response property items/external_roles list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      the /// response's property type changed from no type to string for status

    • ▲

      the / response's property type changed from no type to string for status

    • ●

      added the new Allow enum value to the /// response property for the response status

    • ●

      added the new Deny enum value to the /// response property for the response status

    • ●

      added the new force enum value to the / response property for the response status

    • ●

      added the new ignore enum value to the / response property for the response status

    • ●

      added the new import enum value to the / response property for the response status

    • ○

      removed from the /// response property allOf list for the response status

    • ○

      removed from the / response property allOf list for the response status

  • 639e39b0d1ebRevision changes
    • ▲

      the response's body type changed from string to array for status