Skip to main content
POST
/
v1
/
idps
{  "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>"  }  }  } }

Query Parameters

​
identityProviderId
string

The ID to use for the identity provider, which will become the final component of the identity provider's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

​
validateOnly
boolean

If set to true, the request will be validated without actually creating the identity provider.

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.