GET
/
v1
/
idps
{
  "identityProviders": [
    {
      "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>"
          }
        }
      }
    }
  ],
  "nextPageToken": "<string>"
}

Query Parameters

​
pageSize
integer

Not used. The maximum number of identity providers to return. The service may return fewer than this value. If unspecified, at most 10 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

Not used. A page token, received from a previous ListIdentityProviders call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListIdentityProviders must match the call that provided the page token.

Response

200
application/json

OK

The response is of type object.

GET
/
v1
/
idps
{
  "identityProviders": [
    {
      "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>"
          }
        }
      }
    }
  ],
  "nextPageToken": "<string>"
}

Query Parameters

​
pageSize
integer

Not used. The maximum number of identity providers to return. The service may return fewer than this value. If unspecified, at most 10 will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

Not used. A page token, received from a previous ListIdentityProviders call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListIdentityProviders must match the call that provided the page token.

Response

200
application/json

OK

The response is of type object.