Set Google auth options
POST /api/admin/auth/google/settings
This endpoint has been deprecated and may be removed in future versions of the API.
Updates the settings for Google Authentication (deprecated, please use OpenID instead)
Request
- application/json
Body
required
googleSettingsSchema
- enabled boolean
Is google OIDC enabled
- clientId string required
The google client id, used to authenticate against google
- clientSecret string required
The client secret used to authenticate the OAuth session used to log the user in
- unleashHostname string required
Name of the host allowed to access the Google authentication flow
- autoCreate boolean
Should Unleash create users based on the emails coming back in the authentication reply from Google
- emailDomains string
A comma separated list of email domains that Unleash will auto create user accounts for.
- 200
- 400
- 401
- 403
- 415
googleSettingsSchema
- application/json
- Schema
- Example (from schema)
Schema
- enabled boolean
Is google OIDC enabled
- clientId string required
The google client id, used to authenticate against google
- clientSecret string required
The client secret used to authenticate the OAuth session used to log the user in
- unleashHostname string required
Name of the host allowed to access the Google authentication flow
- autoCreate boolean
Should Unleash create users based on the emails coming back in the authentication reply from Google
- emailDomains string
A comma separated list of email domains that Unleash will auto create user accounts for.
{
"enabled": false,
"clientId": "your-client-id",
"clientSecret": "your-client-secret",
"unleashHostname": "localhost",
"autoCreate": true,
"emailDomains": "getunleash.io,unleash-hosted.com"
}
The request data does not match what we expect.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ValidationError",
"message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}
Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "AuthenticationRequired",
"message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ContentTypeerror",
"message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}