Create an authentication resource

curl --request POST \ --url https://data.us.algolia.com/1/authentications \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --header 'x-algolia-api-key: ALGOLIA_API_KEY' \ --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \ --data ' { "type": "googleServiceAccount", "name": "lorem", "platform": "bigcommerce", "input": { "clientEmail": "service-account-name@project-id.iam.gserviceaccount.com", "privateKey": "lorem" } } '

Authorizations

x-algolia-application-id

string

header

required

Your Algolia application ID.

x-algolia-api-key

string

header

required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Body

application/json

Request body for creating a new authentication resource.

input

Google · object

required

Credentials for authenticating with a Google service account, such as BigQuery.

Show child attributes

name

string

required

Descriptive name for the resource.

type

enum<string>

required

Type of authentication. This determines the type of credentials required in the input object.

Available options:

googleServiceAccount,

basic,

apiKey,

oauth,

algolia,

algoliaInsights,

secrets

platform

enum<string> | null

Name of an ecommerce platform with which to authenticate. This determines which authentication type you can select.

Available options:

bigcommerce,

commercetools,

shopify

Response

API response for the successful creation of an authentication resource.

authenticationID

string

required

Universally unique identifier (UUID) of an authentication resource.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

createdAt

string

required

Date and time when the resource was created, in RFC 3339 format.

name

string

required

Descriptive name for the resource.