API Client endpoint

The API Client endpoint and fields are described below including details of the supported RESTful CRUD verbs. For details of the conventions of the API see the general conventions.

Endpoint path prefix: 

/n/v1/apiclient/

apiclient was introduced in API version V1

API Client has not been marked for deprecation

Description

Endpoint for managing API clients. Clients provide context for API integrations including bearer token access to Baack APIs as well as for OAuth clients integrated with your company.

API clients should be separated by their purpose with permissions set for eachof the use cases.
When your API access is enabled your company starts with a root API client which has an associated bearer token. The main admin client should be used to create API keys for specific use cases.
Do not distribute default API client bearer tokens to devices or the browser as they by default have all permissions on the company.

Verbs / methods

This endpoint supports the following CRUD operations in line with our API conventions. See the conventions section for more details.

CREATE HTTP POST

Request payload

API Client reference

{
  "scope" : "api.baack.co",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "clientID" : "Bearer"
}

Response payload

API Client reference
Representation of an API client

{
  "scope" : "api.baack.co",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "clientID" : "Bearer"
}

Response codes / scenarios

  • CREATE_SUCCESS

    API code CREATE_SUCCESS HTTP status code 201 : When the representation provided was successfully created return HTTP created (201). Note that when other context like authorisation and permissions are satisfied but the representation is invalid or missing required information typically a error representation with details of the missing information may be returned instead with REPRESENTATION_MISSING_REQUIRED_FIELD api error for example

  • INVALID_REPRESENTATION

    API code INVALID_REPRESENTATION HTTP status code 400 : When creating or updating a representation and the provided representation is invalid. May include an error representation with details of the issue

  • BAD_REQUEST

    API code BAD_REQUEST HTTP status code 400 : When the request is invalid or malformed the general bad request response can be returned.