Update an App Client

PUT 
/v1/app-clients/:appClientId

Update an App Client

Request

Path Parameters

appClientId stringrequired

The App Client identifier.

application/json

Body

The request received from the client.

appClientId stringrequired

The App Client identifier.

name stringrequired

The name of the App Client.

description stringrequired

The description of the App Client.

roles string[]required

The names of the roles that the App Client has. This is a subset of the roles of the user creating the App Client.

Responses

200

OK

application/json

Schema

Schema

appClient

object

required

An App Client. An App Client enables you to generate access tokens which are used by the platform the authenticate API requests.

appClientId stringrequired

The identifier of the App Client.

name stringrequired

The name of the App Client.

description stringrequired

The description of the App Client

clientId stringrequired

The client identifier for the App Client

clientSecretHint stringrequired

A hint for the client secret for the App Client.

roles string[]required

The list of roles that the App Client has.

Example (from schema)

{
  "appClient": {
    "appClientId": "string",
    "name": "string",
    "description": "string",
    "clientId": "string",
    "clientSecretHint": "string",
    "roles": [
      "string"
    ]
  }
}

default

Error

application/json

Schema

Schema

code int32

An error status code describing the response.

Enum Value	Description
0	OK
1	Cancelled
2	Unknown
3	InvalidArgument
4	DeadlineExceeded
5	NotFound
6	AlreadyExists
7	PermissionDenied
8	ResourceExhausted
9	FailedPrecondition
10	Aborted
11	OutOfRange
12	Unimplemented
13	Internal
14	Unavailable
15	DataLoss
16	Unauthenticated

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

message string

A developer-facing error message

details

object[]

A list of messages containing details about the errors

Array [

@type stringrequired

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...