Skip to main content

AuthClientRegistrationResponse

successbooleanrequired
data object

Response payload for successful operations.

clientIdstringrequired
displayNamestringrequired

Possible values: non-empty

scopesstring[]required
statusOAuthClientStatus (string)required

Possible values: [ACTIVE, REVOKED]

createdAtstring<date-time>required
organizationIdstringnullable
ownerTypeOAuthClientOwnerType (string)required

Possible values: [PLATFORM, CUSTOMER]

createdByUserIdstringnullable
agentIdstringnullable
appIdstringnullable
revisioninteger<int64>required

Possible values: >= 0

clientSecretstringrequired

One-time client secret. Store it securely because it cannot be retrieved later.

errorstring

Machine-readable error code.

messagestring

Human-readable response message.

AuthClientRegistrationResponse
{
"success": true,
"data": {
"clientId": "string",
"displayName": "string",
"scopes": [
"string"
],
"status": "ACTIVE",
"createdAt": "2024-07-29T15:51:28.071Z",
"organizationId": "string",
"ownerType": "PLATFORM",
"createdByUserId": "string",
"agentId": "string",
"appId": "string",
"revision": 0,
"clientSecret": "string"
},
"error": "string",
"message": "string"
}