Client configurations

Manage Client Configurations

Retrieving clients

get

Retrieves a list of clients for a specified tenant.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Responses

200

OK

application/json

Responsestring[]

400Error

application/json

403Error

application/json

get

/configuration/{tenant}/clients

HTTPcURLJavaScriptPython

GET /configuration/{tenant}/clients HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "saas-ag.caas-indexing-service-client"
]

Retrieving client configurations

get

Retrieves a list of configurations for a specified client.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

clientstringRequired

Desired client's unique identifier.

Query parameters

keysstringOptional

Responses

200

OK

application/json

get

/configuration/{tenant}/clients/{client}/configurations

HTTPcURLJavaScriptPython

GET /configuration/{tenant}/clients/{client}/configurations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

[
  {
    "_id": "saas-ag.caas-indexing-service-client_algolia_activation",
    "client": "saas-ag.caas-indexing-service-client",
    "key": "algolia_activation",
    "value": true
  },
  {
    "_id": "saas-ag.caas-indexing-service-client_indexing_configuration",
    "client": "saas-ag.caas-indexing-service-client",
    "key": "indexing_configuration",
    "value": {
      "activePublishedProductIndexing": true,
      "activeNonPublishedProductIndexing": true
    }
  }
]

Creating client configurations

post

Creates a new client configuration.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

clientstringRequired

Desired client's unique identifier.

Bodyobject · ClientConfiguration[]

application/json

idstring · min: 1Optional

Client configuration unique identifier.

clientstring · min: 1Optional

The client to which the configuration applies.

keystring · min: 1Optional

Client configuration key.

valueone ofOptional

Client configuration value. It can be any valid JSON object.

objectOptional

or

stringOptional

or

object[]Optional

or

booleanOptional

Responses

201

Created

application/json

400

Bad Request

application/json

409

Conflict

application/json

post

/configuration/{tenant}/clients/{client}/configurations

HTTPcURLJavaScriptPython

POST /configuration/{tenant}/clients/{client}/configurations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

[
  {
    "client": "test_client",
    "key": "test_key",
    "value": true
  }
]

[
  {
    "_id": "test_client_test_key",
    "client": "test_client",
    "key": "test_key",
    "value": true
  }
]

Retrieving a client configuration

get

Retrieves a specified client configuration.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

clientstringRequired

Desired client's unique identifier.

propertyKeystringRequired

Desired configuration key.

Responses

200

OK

application/json

404Error

application/json

get

/configuration/{tenant}/clients/{client}/configurations/{propertyKey}

HTTPcURLJavaScriptPython

GET /configuration/{tenant}/clients/{client}/configurations/{propertyKey} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "_id": "saas-ag.caas-indexing-service-client_indexing_configuration",
  "client": "saas-ag.caas-indexing-service-client",
  "key": "indexing_configuration",
  "value": {
    "activePublishedProductIndexing": true,
    "activeNonPublishedProductIndexing": true
  }
}

Updating a client configuration

put

Updates a specified client configuration.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

clientstringRequired

Desired client's unique identifier.

propertyKeystringRequired

Desired configuration key.

Body

application/json

idstring · min: 1Optional

Client configuration unique identifier.

clientstring · min: 1Optional

The client to which the configuration applies.

keystring · min: 1Optional

Client configuration key.

valueone ofOptional

Client configuration value. It can be any valid JSON object.

objectOptional

or

stringOptional

or

object[]Optional

or

booleanOptional

Responses

200

OK

application/json

400

Bad Request

application/json

409

Conflict

application/json

put

/configuration/{tenant}/clients/{client}/configurations/{propertyKey}

HTTPcURLJavaScriptPython

PUT /configuration/{tenant}/clients/{client}/configurations/{propertyKey} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "id": "example_client_example_key",
  "client": "example_client",
  "key": "example_key",
  "value": false
}

{
  "_id": "example_client_example_key",
  "client": "example_client",
  "key": "example_key",
  "value": false
}

Deleting a client configuration

delete

Deletes a specified client configuration.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

clientstringRequired

Desired client's unique identifier.

propertyKeystringRequired

Desired configuration key.

Responses

204

No Content

400

Bad Request

application/json

404

Conflict

application/json

delete

/configuration/{tenant}/clients/{client}/configurations/{propertyKey}

HTTPcURLJavaScriptPython

DELETE /configuration/{tenant}/clients/{client}/configurations/{propertyKey} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content