NVnvidia
Config API

Read Role

Changed on

Read Role

get/api/configs/role/{name}

Request

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

Path parameters

namestring required

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

  • b9d312a13f5dRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a8157dc3279dRevision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

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

    • info

      removed from the response property allOf list for the response status