SSORolePreviewRequest

Fields

Preview the role a user in groups gets. role_mapping / default_role preview an unsaved edit; omitted, the stored configuration answers.

3 fields

default_role

string or null

groups

array of string

role_mapping

object or null

Raw schema (JSON)

{
  "description": "W20 ADM-08a: preview the role a user in ``groups`` gets. ``role_mapping`` / ``default_role`` preview an\nunsaved edit; omitted, the stored configuration answers.",
  "properties": {
    "default_role": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Default Role"
    },
    "groups": {
      "items": {
        "type": "string"
      },
      "maxItems": 200,
      "title": "Groups",
      "type": "array"
    },
    "role_mapping": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Role Mapping"
    }
  },
  "title": "SSORolePreviewRequest",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/sso/configs/{config_id}/preview-role — Preview Sso Role

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON