Apiclient

get/local-user-store/api/v1/api-clients

List API clients

Get all API clients.

offsetint

Collection query offset

Default: 0
Min: 0

limitint

Maximum number of collection items to return

Default: 50

sortkeystring

Sort by specific object property

sortdirstring

Sort direction, asc or desc

Default: "ASC"
Enum: ASC
DESC

Responses

Response examples

Successful response, returns an array of API clients, returns an empty array if no API clients defined

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "secret": "string",
      "name": "string",
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "roles": [
        {
          "id": "string",
          "name": "string",
          "deleted": true
        }
      ],
      "oauth_client_id": "string",
      "oauth_client_secret": "string"
    }
  ]
}

post/local-user-store/api/v1/api-clients

Create an API client

Create a new API client. ID, client_secret, author, created, updated, and updated_by fields are automatically populated by the server.

namestring

required

rolesarray

List of roles possessed by the API client

idstring

required

Role ID

namestring

Role name, ignored by server in requests.

Responses

Request examples

{
  "name": "string",
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Response examples

API client successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}

post/local-user-store/api/v1/api-clients/search

Find API clients

Find API clients.

keywordsstring

Comma or space-separated strings to search in apiclients' names.

Responses

Request examples

{
  "keywords": "string"
}

Response examples

Successful response, returns an array of API clients, returns an empty array if no API clients defined

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "secret": "string",
      "name": "string",
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "roles": [
        {
          "id": "string",
          "name": "string",
          "deleted": true
        }
      ],
      "oauth_client_id": "string",
      "oauth_client_secret": "string"
    }
  ]
}

get/local-user-store/api/v1/api-clients/{api_client_id}

Get an API client

Get an API client by ID.

api_client_idstring

required

API client ID

Responses

Response examples

Successful response, returns a trusted client if found

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "secret": "string",
  "name": "string",
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "deleted": true
    }
  ],
  "oauth_client_id": "string",
  "oauth_client_secret": "string"
}

put/local-user-store/api/v1/api-clients/{api_client_id}

Update an API client

Update an API client by ID.

namestring

required

rolesarray

List of roles possessed by the API client

idstring

required

Role ID

namestring

Role name, ignored by server in requests.

Responses

Request examples

{
  "name": "string",
  "roles": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Response examples

Trusted client successfully updated

Empty response

delete/local-user-store/api/v1/api-clients/{api_client_id}

Delete an API client

Delete an API client by ID.

api_client_idstring

required

API client ID

Responses

Response examples

API client successfully deleted

Empty response