Sign in
Admin

Create a login provider

post/admin/login-providers

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /admin/login-providers
  • Auth: HTTP bearer

Request body

baseUrlstring

Instance base URL (GitLab only; GitHub is always github.com)

clientIdstring required
clientSecretstring required

OAuth client secret; sealed at rest, never returned

displayNamestring

Label shown on the login button; defaults to the registrationId

registrationIdstring required

Stable id used in the OAuth callback path and identity resolution

scopesstring

Space-separated scopes; defaulted by provider type if omitted

type'GITHUB' | 'GITLAB' | 'SLACK' | 'OUTLINE' required

Example request

{
  "baseUrl": "https://gitlab.example.com",
  "registrationId": "gitlab-acme"
}

Response

Login provider created; URL in the Location header

baseUrlstring required
createdAtstring date-time required
displayNamestring required
enabledboolean
redirectUristring required

Redirect/callback URI to register on the upstream OAuth app

registrationIdstring required
scopesstring required
seededFromEnvboolean
typestring required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.