Memos

Update Identity Provider

UpdateIdentityProvider updates an identity provider. Requires the admin role. Providers configured by the deployment cannot be updated.

PATCH
/api/identity-providers/{identity-provider}

Path Parameters

identity-provider*string

The identity-provider id.

Query Parameters

updateMask?string

Required. The fields to update. Supported paths: title, identifier_filter, config; other paths are ignored. An empty OAuth2 client secret in config keeps the stored secret.

Formatfield-mask

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

IdentityProvider is an external identity provider users can sign in with.

Response Body

application/json

application/json

curl -X PATCH "https://example.com/api/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"      }    }  }}

List Identity Providers

ListIdentityProviders lists identity providers. Public, so the sign-in page can show SSO options. Client secrets are never returned.

Batch Get Instance Settings

BatchGetInstanceSettings gets up to 100 instance settings in request order, with the same access rules as GetInstanceSetting. The call fails if any setting cannot be returned.