Memos

Create Identity Provider

CreateIdentityProvider creates an identity provider. Requires the admin role. Fails with FAILED_PRECONDITION when the ID belongs to a provider configured by the deployment.

POST
/api/identity-providers

Query Parameters

identityProviderId?string

Optional. The ID to use for the identity provider, which becomes the final component of the resource name. If empty, the server generates one. Format: ^a-zA-Z0-9?$

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

Sign Out

SignOut ends the current session. Revokes the refresh token from the cookie and clears the cookie.

Delete Identity Provider

DeleteIdentityProvider deletes an identity provider. Requires the admin role. Providers configured by the deployment cannot be deleted. Fails with FAILED_PRECONDITION when password sign-in is disabled for regular users and no other effective provider remains.