API Reference

Krystal Identity API

Resources & Endpoints

Update OAuth client

Update details for an OAuth client.

PATCH
https://identity.krystal.io/api/v1/oauth_clients/{oauth_client}

If successful, this endpoint will return a 200 OK 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

oauth_client Required

OAuth Client Lookup None

properties Required

OAuthClientProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

oauth_client_not_found

No client was found matching any of the criteria provided in the arguments

 404 Not Found

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?
    }
}