Client configurations

Manage Client Configurations

Retrieving clients

get

Retrieves a list of clients for a specified tenant.


Required scopes

  • configuration.configuration_view

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Responses
200
OK
application/json
Responsestring[]
get
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

  • configuration.configuration_view

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's 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
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

  • configuration.configuration_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

clientstringRequired

Desired client's unique identifier.

Bodyobject · ClientConfiguration[]
idstring · min: 1Optional

Client configuration's unique identifier.

clientstring · min: 1Optional

The client to which the configuration applies.

keystring · min: 1Optional

Client configuration's key.

valueone ofOptional

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

objectOptional
or
stringOptional
or
object[]Optional
or
booleanOptional
Responses
201
Created
application/json
post
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

  • configuration.configuration_view

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

clientstringRequired

Desired client's unique identifier.

propertyKeystringRequired

Desired configuration's key.

Responses
200
OK
application/json
get
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

  • configuration.configuration_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

clientstringRequired

Desired client's unique identifier.

propertyKeystringRequired

Desired configuration's key.

Body
idstring · min: 1Optional

Client configuration's unique identifier.

clientstring · min: 1Optional

The client to which the configuration applies.

keystring · min: 1Optional

Client configuration's key.

valueone ofOptional

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

objectOptional
or
stringOptional
or
object[]Optional
or
booleanOptional
Responses
200
OK
application/json
put
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: 83

{
  "id": "test_client_test_key",
  "client": "test_client",
  "key": "test_key",
  "value": false
}
{
  "_id": "test_client_test_key",
  "client": "test_client",
  "key": "test_key",
  "value": false
}

Deleting a client configuration

delete

Deletes a specified client configuration.


Required scopes

  • configuration.configuration_manage

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

clientstringRequired

Desired client's unique identifier.

propertyKeystringRequired

Desired configuration's key.

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

No content

Was this helpful?