IdentityProvider

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

• POSTCreate Identity Provider/api/v1/identity-providers
• GETGet Identity Provider/api/v1/identity-providers/{identity-provider}
• PATCHUpdate Identity Provider/api/v1/identity-providers/{identity-provider}

Referenced by these component schemas:

• ListIdentityProvidersResponse

Shape and fields

object

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "required": [
    "type",
    "title",
    "config"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The resource name of the identity provider.\n Format: identity-providers/{idp}"
    },
    "type": {
      "enum": [
        "TYPE_UNSPECIFIED",
        "OAUTH2"
      ],
      "type": "string",
      "description": "Required. The type of the identity provider.",
      "format": "enum"
    },
    "title": {
      "type": "string",
      "description": "Required. The display title of the identity provider."
    },
    "identifierFilter": {
      "type": "string",
      "description": "Optional. Filter applied to user identifiers."
    },
    "config": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityProviderConfig"
        }
      ],
      "description": "Required. Configuration for the identity provider."
    }
  }
}