Skip to main content

CreateAPIClientResponse

Response from creating an API client. Contains the client_secret which is shown only once.

type CreateAPIClientResponse {
id: ID!
name: String!
clientId: String!
clientSecret: String!
role: String!
createdAt: Time!
}

Fields

CreateAPIClientResponse.id ● ID! non-null scalar

Database entity ID

CreateAPIClientResponse.name ● String! non-null scalar

Display name

CreateAPIClientResponse.clientId ● String! non-null scalar

Client ID for authentication (used in client_credentials grant)

CreateAPIClientResponse.clientSecret ● String! non-null scalar

Client secret (ONE-TIME DISPLAY - store securely, cannot be retrieved again)

CreateAPIClientResponse.role ● String! non-null scalar

Role assigned to this API client (admin, viewer)

CreateAPIClientResponse.createdAt ● Time! non-null scalar

When the API client was created

Returned By

createAPIClient mutation ● regenerateAPIClientSecret mutation