Skip to main content
PATCH
/
v1
/
idps
/
{idp}
{
  "name": "<string>",
  "title": "<string>",
  "domain": "<string>",
  "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED",
  "config": {
    "oauth2Config": {
      "authUrl": "<string>",
      "tokenUrl": "<string>",
      "userInfoUrl": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "scopes": [
        "<string>"
      ],
      "fieldMapping": {
        "identifier": "<string>",
        "displayName": "<string>",
        "phone": "<string>",
        "groups": "<string>"
      },
      "skipTlsVerify": true,
      "authStyle": "OAUTH2_AUTH_STYLE_UNSPECIFIED"
    },
    "oidcConfig": {
      "issuer": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "scopes": [
        "<string>"
      ],
      "fieldMapping": {
        "identifier": "<string>",
        "displayName": "<string>",
        "phone": "<string>",
        "groups": "<string>"
      },
      "skipTlsVerify": true,
      "authStyle": "OAUTH2_AUTH_STYLE_UNSPECIFIED",
      "authEndpoint": "<string>"
    },
    "ldapConfig": {
      "host": "<string>",
      "port": 123,
      "skipTlsVerify": true,
      "bindDn": "<string>",
      "bindPassword": "<string>",
      "baseDn": "<string>",
      "userFilter": "<string>",
      "securityProtocol": "SECURITY_PROTOCOL_UNSPECIFIED",
      "fieldMapping": {
        "identifier": "<string>",
        "displayName": "<string>",
        "phone": "<string>",
        "groups": "<string>"
      }
    }
  }
}

Path Parameters

​
idp
string
required

The idp id.

Query Parameters

​
updateMask
string<field-mask>

The list of fields to update.

​
allowMissing
boolean

If set to true, and the identity provider is not found, a new identity provider will be created. In this situation, update_mask is ignored.

Body

application/json
​
name
string

The name of the identity provider. Format: idps/{idp}

​
title
string

The display title of the identity provider.

​
domain
string

The domain for email matching when using this identity provider.

​
type
enum<string>

The type of identity provider protocol.

Available options:
IDENTITY_PROVIDER_TYPE_UNSPECIFIED,
OAUTH2,
OIDC,
LDAP
​
config
object

The configuration details for the identity provider.

Response

OK

​
name
string

The name of the identity provider. Format: idps/{idp}

​
title
string

The display title of the identity provider.

​
domain
string

The domain for email matching when using this identity provider.

​
type
enum<string>

The type of identity provider protocol.

Available options:
IDENTITY_PROVIDER_TYPE_UNSPECIFIED,
OAUTH2,
OIDC,
LDAP
​
config
object

The configuration details for the identity provider.