Create Identity Provider

Query Parameters

identityProviderId?string

Optional. The ID to use for the identity provider, which will become the final component of the resource name. If not provided, the system will generate one.

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 POST "https://example.com/api/v1/identity-providers" \  -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"
    }
  ]
}

Create Identity Provider

Query Parameters

Request Body

Response Body

200application/json

defaultapplication/json

On this page

`application/json`

`application/json`