Get Google auth settings

GET <your-unleash-url>/api/admin/auth/google/settings

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Returns the current settings for Google Authentication (deprecated, please use OpenID instead)

Request

Responses

• 200
• 400
• 401
• 403

---

googleSettingsSchema

application/json

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.

Example (from schema)

{
  "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

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.

Example (from schema)

{
  "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

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.

Example (from schema)

{
  "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

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.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

curl / cURL

curl -L -X GET '<your-unleash-url>/api/admin/auth/google/settings' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/api/admin/auth/google/settings' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/api/admin/auth/google/settings' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET '<your-unleash-url>/api/admin/auth/google/settings' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/api/admin/auth/google/settings' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET '<your-unleash-url>/api/admin/auth/google/settings' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/api/admin/auth/google/settings' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/api/admin/auth/google/settings' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/api/admin/auth/google/settings' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'