Skip to main content
POST
/
v1
/
apiClients
Create ApiClient
curl --request POST \
  --url https://iam.eu.confidence.dev/v1/apiClients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "displayName": "<string>",
  "clientId": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "identity": "<string>",
  "name": "<string>",
  "description": "<string>",
  "clientSecret": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The body is of type object.

Response

200 - application/json

OK

An API client that can be used to programmatically access the Confidence APIs.

displayName
string
required

Human friendly name of the API client.

clientId
string
required

Id of the API client.

createTime
object
required

Time when the API client was first created.

updateTime
object
required

Time when the API client was last updated.

creator
string
required

Reference to the identity that created this API client.

updater
string
required

Reference to the identity that last updated this API client.

identity
string
required

Reference to the identity this API client represents.

name
string

Name of the API client on the form apiClients/{"<"}id{">"}.

description
string

A description of the API client, e.g. what it is for.

clientSecret
string

The client secret for the client.

labels
object[]

General labels for this resource.

owner
string

The owner of the resource. If not set will default to the creator.