2.1.1 ClientApp object

Represents an API client application. This is an external application that has integrated the Drillster API.

Example

{
  "id": "874a16d4ac764ce4a545f0cca4584c63",
  "name": "Acme LMS",
  "icon": {
    "type": "image/png",
    "url": "https://www.drillster.com/bin/attachment/11d19f33700676e94e34b27534ea7d20c3143ae0"
  }
}

Fields

Field	Type	Description
`id` required	String	The client ID for the external application.
`name` required	String	The name of the client application.
`icon` optional	2.1.1 Media	An optional icon representing the client application.
`secret` optional	String	The OAuth client secret. This value is only accessible by the owner/creator of the client app.
`creator` optional	2.1.1 Actor object	The user or organization that created and owns this client application.
`created` optional	Timestamp	The time the client app was created. Example value: `2010-03-12T15:47:31Z`
`status` optional	String constant	Indicates whether this client app is official or experimental. This value is shown to end user on the OAuth approval screen. Newly registered client applications start their live as experimental. Only Drillster support staff can promote an app's status to official. Please send your request to support@drillster.com to have this taken care of. Example values: `OFFICIAL`, `EXPERIMENTAL`
`description` optional	String	An optional description of the client application. This value is shown to end user on the OAuth approval screen.
`redirectionEndpoint` optional	String	The redirection URI for this client application. This is the URI that users will be redirected to after allowing or declining access by this client app to their account. For more information, please see the OAuth documentation.
`url` optional	String	An optional URL to the website of the client application to learn more about this application. The value, if present, is shown to end user on the OAuth approval screen.
`userCredentialFlowPermitted` optional	Boolean	An optional flag to indicate whether this client application may make use of the user credential flow. This feature is not available to third party applications.

Last updated on 2024-10-02