API Reference

Krystal Identity API

Resources & Endpoints

Create an OAuth client

Creates a new OAuth client for the authenticated user.

POST
https://identity.krystal.io/api/v1/oauth_clients

If successful, this endpoint will return a 201 Created status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

properties Required

OAuthClientProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

validation_error

An error ocurred with the input provided

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    oauth_client: OAuthClient {
        id: String
        auth_method: String
        client_credentials: Boolean
        description: String?
        first_party: Boolean
        name: String
        redirect_uris: [ String ]
        verified: Boolean
        webhook_url: String?
    }
    secret: String
}