Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
Clients

Connects a client

Exchanges temporary pin for full oauth client credentials

post/clients/connect

Request body

pinstring required

Previously temporarily issued PIN from the Voucher Admin UI (30 minutes validity)

Example request

{
  "pin": "X53HI0"
}

Response

OK

idstring

Primary identification key - will be used in client calls

client_group_idstring

Primary identification key from the selected group (id)

namestring

Naming or description of the client

secretstring

secret

scopesstring[]
created_atstring RFC3339

created_at - datetime in RFC3339 format, see https://tools.ietf.org/html/rfc3339

updated_atstring RFC3339

updated_at - datetime in RFC3339 format, see https://tools.ietf.org/html/rfc3339

connected_atstring RFC3339

connected_at - datetime in RFC3339 format, see https://tools.ietf.org/html/rfc3339

typestring

The type of this client

Example response

{
  "id": "da39a3ee5eb28b7392ef5",
  "client_group_id": "cff8784e5eb28b81ca02a",
  "name": "Test-Client",
  "secret": "VrhgrKVDTqjg1GVr3R6Juvx7FfHQK7Psim7ORAXm",
  "created_at": "2017-07-21T17:32:28+00:00",
  "updated_at": "2017-07-21T17:32:28+00:00",
  "connected_at": "2017-07-21T17:32:28+00:00",
  "type": "pos"
}