Skip to main content

Update a client

OAuth clients help web applications to get access to a resource server. Here configuration helps to manage them in order to use boruta for authentication and authorization. Beyond authorization, clients are the entrypoint for decentralized identity flows. The field descriptions are available in the main documentation pages.

PATCH /api/clients/:client_id updates the identified client resource

Path Parameters
client_id string REQUIRED
Request Body REQUIRED
client object REQUIRED
access_token_ttl int32
authorization_code_ttl int32
authorize_scope boolean
authorized_scopes string[]
id string
id_token_ttl int32
name string
pkce boolean
public_refresh_token boolean
public_revoke boolean
redirect_uris string[]
refresh_token_ttl int32
identity_provider object REQUIRED
id string REQUIRED
choose_session boolean
confirmable boolean
consentable boolean
name string
registrable boolean
type string
secret string
supported_grant_types string[]
Responses
200
Schema OPTIONAL
data object OPTIONAL
access_token_ttl int32 OPTIONAL
authorization_code_ttl int32 OPTIONAL
authorize_scope boolean OPTIONAL
authorized_scopes string[] OPTIONAL
id string OPTIONAL
id_token_ttl int32 OPTIONAL
name string OPTIONAL
pkce boolean OPTIONAL
public_refresh_token boolean OPTIONAL
public_revoke boolean OPTIONAL
redirect_uris string[] OPTIONAL
refresh_token_ttl int32 OPTIONAL
identity_provider object
id string
choose_session boolean OPTIONAL
confirmable boolean OPTIONAL
consentable boolean OPTIONAL
name string OPTIONAL
registrable boolean OPTIONAL
type string OPTIONAL
secret string OPTIONAL
supported_grant_types string[] OPTIONAL
401

The client is unauthorized to access this resource.

Schema OPTIONAL
code string
message string
403

The client is forbidden to access this resource.

Schema OPTIONAL
code string
message string
404

The requested resource could not be found.

Schema OPTIONAL
code string
message string