List authentication resources

Retrieves a list of all authentication resources.

GET /1/authentications

curl

cURL

curl --request GET \
  --url 'https://data.us.algolia.com/1/authentications?itemsPerPage=10&page=1&type=basic%2Coauth&platform=commercetools%2Cnone&sort=createdAt&order=desc' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "authentications": [
    {
      "authenticationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "type": "googleServiceAccount",
      "name": "<string>",
      "input": {
        "clientEmail": "[e-mail]",
        "privateKey": "<string>"
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "platform": "bigcommerce",
      "owner": "<string>"
    }
  ],
  "pagination": {
    "nbPages": 2,
    "page": 2,
    "nbItems": 1,
    "itemsPerPage": 10
  }
}

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.

Query Parameters

itemsPerPage · integer · default: 10

Number of items per page.

Required range: 1 <= x <= 100

page · integer

Page number of the paginated API response. Page of the API response to retrieve.

Required range: x >= 1

type · enum<string>[]

Type of authentication resource to retrieve.

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

Available options: googleServiceAccount, basic, apiKey, oauth, algolia, algoliaInsights, secrets

Example:

"basic,oauth"

platform · enum<string> · null · enum<string>[]

Ecommerce platform for which to retrieve authentications.

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

Available options: bigcommerce, commercetools, shopify

Example:

"commercetools,none"

sort · enum<string> · default: createdAt

Property by which to sort the list of authentications.

Available options: name, type, platform, updatedAt, createdAt

order · enum<string> · default: desc

Sort order of the response, ascending or descending. Ascending or descending sort order.

Available options: asc, desc

Response

200

application/json

OK

authentications · object[] · required

Show child attributes

authentications. authenticationID · string · required

Universally unique identifier (UUID) of an authentication resource.

Example:

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

authentications. 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

authentications. name · string · required

Descriptive name for the resource.

authentications. input · object · required

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

Option 1

Show child attributes

authentications.input. clientEmail · string

Email address of the Google service account.

Example:

"[e-mail]"

authentications.input. privateKey · string

Private key of the Google service account. This field is null in the API response.

authentications. createdAt · string · required

Date of creation in RFC 3339 format.

authentications. updatedAt · string · required

Date of last update in RFC 3339 format.

authentications. 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

authentications. owner · string | null

Owner of the resource.

pagination · object · required

Paginated API response.

Show child attributes

pagination. nbPages · integer · required

Number of pages in the API response.

Required range: x >= 1

pagination. page · integer · required

Page of the API response to retrieve.

Required range: x >= 1

pagination. nbItems · integer · required

Number of items in the API response.

Required range: x >= 0

pagination. itemsPerPage · integer · default: 10 · required

Number of items per page.

Required range: 1 <= x <= 100