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

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstringRequired

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Responses

200

OK

application/json

string[]Optional

400Error

application/json

403Error

application/json

get/configuration/{tenant}/clients

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

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

keystring · min: 1Required

Configuration key.

valueone ofRequired

Configuration value. It can be any valid JSON object.

objectOptional

or

stringOptional

or

object[]Optional

or

booleanOptional

versionintegerOptional

Configuration version.

descriptionstringOptional

Describes purpose of the configuration.

securedbooleanOptional

Flag indicating whether the configuration should be encrypted. It works only if value field is of string type.

Default: false

restrictedbooleanOptional

Flag indicating whether the configuration should be restricted. When configuration is rectricted then it cannot be deleted. When this property is set to true then it cannot be unset.

Default: false

readOnlybooleanOptional

Flag indicating whether the configuration should be readOnly. When configuration is readOnly then it cannot be updated.

Default: false

schemaUrlstring · uriOptional

URL of Json Schema for validation purpose. When configuration is created this value can be provided and then each update operation will be validated against this schema. This property cannot be updated so once set it cannot be unset. The Json Schema should contain one root property named value in order to work correctly. An example of a valid schema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["value"], "properties": { "value": { "type": "boolean" } } }

_idstring · min: 1Optional

The client configuration unique identifier.

clientstring · min: 1Optional

The client to which the configuration applies.

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

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

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.

Bodyall of[]

keystring · min: 1Required

Configuration key.

valueone ofRequired

Configuration value. It can be any valid JSON object.

objectOptional

or

stringOptional

or

object[]Optional

or

booleanOptional

versionintegerOptional

Configuration version.

descriptionstringOptional

Describes purpose of the configuration.

securedbooleanOptional

Flag indicating whether the configuration should be encrypted. It works only if value field is of string type.

Default: false

restrictedbooleanOptional

Flag indicating whether the configuration should be restricted. When configuration is rectricted then it cannot be deleted. When this property is set to true then it cannot be unset.

Default: false

readOnlybooleanOptional

Flag indicating whether the configuration should be readOnly. When configuration is readOnly then it cannot be updated.

Default: false

schemaUrlstring · uriOptional

URL of Json Schema for validation purpose. When configuration is created this value can be provided and then each update operation will be validated against this schema. This property cannot be updated so once set it cannot be unset. The Json Schema should contain one root property named value in order to work correctly. An example of a valid schema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["value"], "properties": { "value": { "type": "boolean" } } }

_idstring · min: 1Optional

The client configuration unique identifier.

clientstring · min: 1Optional

The client to which the configuration applies.

Responses

201

Created

application/json

keystring · min: 1Required

Configuration key.

valueone ofRequired

Configuration value. It can be any valid JSON object.

objectOptional

or

stringOptional

or

object[]Optional

or

booleanOptional

versionintegerOptional

Configuration version.

descriptionstringOptional

Describes purpose of the configuration.

securedbooleanOptional

Flag indicating whether the configuration should be encrypted. It works only if value field is of string type.

Default: false

restrictedbooleanOptional

Flag indicating whether the configuration should be restricted. When configuration is rectricted then it cannot be deleted. When this property is set to true then it cannot be unset.

Default: false

readOnlybooleanOptional

Flag indicating whether the configuration should be readOnly. When configuration is readOnly then it cannot be updated.

Default: false

schemaUrlstring · uriOptional

URL of Json Schema for validation purpose. When configuration is created this value can be provided and then each update operation will be validated against this schema. This property cannot be updated so once set it cannot be unset. The Json Schema should contain one root property named value in order to work correctly. An example of a valid schema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["value"], "properties": { "value": { "type": "boolean" } } }

_idstring · min: 1Optional

The client configuration unique identifier.

clientstring · min: 1Optional

The client to which the configuration applies.

400

Bad Request

application/json

409

Conflict

application/json

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

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

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

keystring · min: 1Required

Configuration key.

valueone ofRequired

Configuration value. It can be any valid JSON object.

objectOptional

or

stringOptional

or

object[]Optional

or

booleanOptional

versionintegerOptional

Configuration version.

descriptionstringOptional

Describes purpose of the configuration.

securedbooleanOptional

Flag indicating whether the configuration should be encrypted. It works only if value field is of string type.

Default: false

restrictedbooleanOptional

Flag indicating whether the configuration should be restricted. When configuration is rectricted then it cannot be deleted. When this property is set to true then it cannot be unset.

Default: false

readOnlybooleanOptional

Flag indicating whether the configuration should be readOnly. When configuration is readOnly then it cannot be updated.

Default: false

schemaUrlstring · uriOptional

URL of Json Schema for validation purpose. When configuration is created this value can be provided and then each update operation will be validated against this schema. This property cannot be updated so once set it cannot be unset. The Json Schema should contain one root property named value in order to work correctly. An example of a valid schema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["value"], "properties": { "value": { "type": "boolean" } } }

_idstring · min: 1Optional

The client configuration unique identifier.

clientstring · min: 1Optional

The client to which the configuration applies.

404Error

application/json

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

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

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

keystring · min: 1Required

Configuration key.

valueone ofRequired

Configuration value. It can be any valid JSON object.

objectOptional

or

stringOptional

or

object[]Optional

or

booleanOptional

versionintegerOptional

Configuration version.

descriptionstringOptional

Describes purpose of the configuration.

securedbooleanOptional

Flag indicating whether the configuration should be encrypted. It works only if value field is of string type.

Default: false

restrictedbooleanOptional

Flag indicating whether the configuration should be restricted. When configuration is rectricted then it cannot be deleted. When this property is set to true then it cannot be unset.

Default: false

readOnlybooleanOptional

Flag indicating whether the configuration should be readOnly. When configuration is readOnly then it cannot be updated.

Default: false

schemaUrlstring · uriOptional

URL of Json Schema for validation purpose. When configuration is created this value can be provided and then each update operation will be validated against this schema. This property cannot be updated so once set it cannot be unset. The Json Schema should contain one root property named value in order to work correctly. An example of a valid schema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["value"], "properties": { "value": { "type": "boolean" } } }

_idstring · min: 1Optional

The client configuration unique identifier.

clientstring · min: 1Optional

The client to which the configuration applies.

Responses

200

OK

application/json

keystring · min: 1Required

Configuration key.

valueone ofRequired

Configuration value. It can be any valid JSON object.

objectOptional

or

stringOptional

or

object[]Optional

or

booleanOptional

versionintegerOptional

Configuration version.

descriptionstringOptional

Describes purpose of the configuration.

securedbooleanOptional

Flag indicating whether the configuration should be encrypted. It works only if value field is of string type.

Default: false

restrictedbooleanOptional

Flag indicating whether the configuration should be restricted. When configuration is rectricted then it cannot be deleted. When this property is set to true then it cannot be unset.

Default: false

readOnlybooleanOptional

Flag indicating whether the configuration should be readOnly. When configuration is readOnly then it cannot be updated.

Default: false

schemaUrlstring · uriOptional

URL of Json Schema for validation purpose. When configuration is created this value can be provided and then each update operation will be validated against this schema. This property cannot be updated so once set it cannot be unset. The Json Schema should contain one root property named value in order to work correctly. An example of a valid schema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["value"], "properties": { "value": { "type": "boolean" } } }

400

Bad Request

application/json

409

Conflict

application/json

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

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

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

objectOptional

Responses

204

No Content

No content

400

Bad Request

application/json

404

Not found

application/json

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

DELETE /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: 2

{}

No content