Update Identity Provider

Path Parameters

identity-provider*string

The identity-provider id.

Query Parameters

updateMask?string

Required. The update mask applies to the resource. Only the top level fields of IdentityProvider are supported.

Formatfield-mask

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

The resource name of the identity provider. Format: identity-providers/{idp}

type*string

Required. The type of the identity provider.

Formatenum

Value in"TYPE_UNSPECIFIED" | "OAUTH2"

title*string

Required. The display title of the identity provider.

identifierFilter?string

Optional. Filter applied to user identifiers.

config*

Required. Configuration for the identity provider.

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/identity-providers/string" \  -H "Content-Type: application/json" \  -d '{    "type": "TYPE_UNSPECIFIED",    "title": "string",    "config": {}  }'

{
  "name": "string",
  "type": "TYPE_UNSPECIFIED",
  "title": "string",
  "identifierFilter": "string",
  "config": {
    "oauth2Config": {
      "clientId": "string",
      "clientSecret": "string",
      "authUrl": "string",
      "tokenUrl": "string",
      "userInfoUrl": "string",
      "scopes": [
        "string"
      ],
      "fieldMapping": {
        "identifier": "string",
        "displayName": "string",
        "email": "string",
        "avatarUrl": "string"
      }
    }
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Update Identity Provider

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

defaultapplication/json

On this page

`application/json`

`application/json`