Request OpenID Connect provider authentication information

v1.0.0

Description:

Provides information about OpenID Connect authentication options.

Precondition:

None.

Postcondition:

OpenID Connect authentication options information is returned.

Further Information:

None.

Input

{
  "type": "object",
  "properties": {
    "is_global_available": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "List of OpenID Connect providers",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "description": "List of available OpenID Connect identity providers",
      "items": {
        "type": "object",
        "description": "OpenID Connect provider information",
        "required": [
          "id",
          "isGlobalAvailable",
          "issuer",
          "mappingClaim",
          "name"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "ID"
          },
          "isGlobalAvailable": {
            "type": "boolean",
            "description": "Is available for all customers"
          },
          "issuer": {
            "type": "string",
            "description": "Issuer identifier of the IDP\n\nThe value is a case sensitive URL."
          },
          "mappingClaim": {
            "type": "string",
            "description": "Name of the claim which is used for the user mapping."
          },
          "name": {
            "type": "string",
            "description": "Name of the IDP"
          },
          "userManagementUrl": {
            "type": "string",
            "description": "URL of the user management UI.\n\nUse empty string to remove."
          }
        }
      }
    }
  }
}