API Client object representation

The apiclient object representation and fields are described below.

apiclient was introduced in API version V1

apiclient has not been marked for deprecation

Usages

API Client

Description

Representation of an API client

Example create representation

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

Example response representation

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

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.
scope	String literal	Scope of the API client, for clients with server side bearer tokens or client tokens accessing Baack APIs the scope must be set to api.baack.co	Required on create.
owner	company	The owning company this API Client is associated with.	Required on create. Ignored on update.
clientID	String literal	The client ID of this client. This field can be set to a meaningful name for clients created via the API to distinguish different clients. The field is also used in third party integration contexts to store the client ID for OAuth client details.	Required on create.