Skip to main content
PATCH
/
1
/
authentications
/
{authenticationID}
curl
curl --request PATCH \
  --url https://data.us.algolia.com/1/authentications/6c02aeb1-775e-418e-870b-1faccd4b2c0f \
  --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"}}'
{
  "authenticationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "name": "<string>",
  "updatedAt": "<string>"
}
Required ACL: addObject, deleteIndex, editSettings

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.

Path Parameters

​
authenticationID
string
required

Unique identifier of an authentication resource.

Example:

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

Body

application/json

Request body for updating an authentication resource.

​
type
enum<string>

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

Available options:
googleServiceAccount,
basic,
apiKey,
oauth,
algolia,
algoliaInsights,
secrets
​
name
string

Descriptive name for the resource.

​
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
​
input
object

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

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7

Response

OK

API response for a successful update of an authentication resource.

​
authenticationID
string
required

Universally unique identifier (UUID) of an authentication resource.

Example:

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

​
name
string
required

Descriptive name for the resource.

​
updatedAt
string
required

Date of last update in RFC 3339 format.

⌘I