apiclient

Download Spec

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

Gets API clients.

offset

int

Offset where to start fetching the items

Default
0

limit

int

Number of items to return

Default
50

sortkey

string

Sort by specific object property

sortdir

string

Sort direction, asc or desc

Default
"ASC"
Enum
  • ASC
  • DESC

Response

ExamplesSchema

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 a new API client. ID, client_secret, author, created, updated, and updated_by fields are automatically populated by the server.

name

string

required

roles

array[object]

List of roles possessed by the API client

Request

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

Response

ExamplesSchema

API client successfully created

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

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

Gets API clients.

keywords

string

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

Request

{
  "keywords": "string"
}

Response

ExamplesSchema

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}

Gets API client object by ID.

api_client_id

string

required

API client ID

Response

ExamplesSchema

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.

name

string

required

roles

array[object]

List of roles possessed by the API client

Request

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

Response

ExamplesSchema

Trusted client successfully updated

Empty response

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

Delete an API client by ID.

api_client_id

string

required

API client ID

Response

ExamplesSchema

API client successfully deleted

Empty response

Was this page helpful?