Developers

Update Client

Update your client related settings.

Scopes
write:client

Path Parameters

client_id
string
REQUIRED

Client id

Request Body

client_name
string

Client name for displaying purposes.

description
string

Additional description for the client

first_party
boolean

Is client first party

grant_types
array<string>
logo_uri
string
logout_uris
array<string>
oidc_conformant
boolean
redirect_uris
array<string>
response_types
array<string>
token_endpoint_auth_method
string
connectors
object
connectors.
saml
object
connectors.saml.
consumer_service
string

Your SAML SP's assertion consumer endpoint.

connectors.saml.
enabled
boolean
connectors.saml.
entity_id
string
connectors.saml.
metadata_url
string

Your SAML SP's metadata URL.

connectors.saml.
relay_state
string

Application specific resource in an IDP initiated Single Sign-On scenario. In most instances this is blank.

connectors.saml.
request_binding
string

Available Values:HTTP-POSTHTTP-Redirect

connectors.saml.
sign_assertions
boolean
connectors.saml.
sign_out_enabled
boolean
connectors.saml.
sign_out_url
string
connectors.saml.
signature_algorithm
string

Available Values:sha512sha256sha1

connectors.saml.
signed_requests
boolean
connectors.saml.
signing_certificate
string
connectors.saml.
mappings
object
connectors.
wsfed
object
connectors.wsfed.
callback_url
string

Your WS Fed application's callback uri.

connectors.wsfed.
enabled
boolean
connectors.wsfed.
realm
string

Application identifier (wtrealm parameter)

connectors.wsfed.
validity
number
min60

Validity time in seconds

extra_metadata
object
jwks
object
jwks.
keys
array<object>
PATCH
/clients/{client_id}
1
2
3
4
5
Loading...
Response:
200
Loading...

Response Body Schema

client_id
string
REQUIRED

Unique client identifier.

client_name
string
REQUIRED

Client name for displaying purposes.

client_secret
string
REQUIRED

Unique client identifier.

description
string

Additional description for the client

first_party
boolean

Is client first party

grant_types
array<string>
REQUIRED
logo_uri
string
logout_uris
array<string>
REQUIRED
oidc_conformant
boolean
redirect_uris
array<string>
REQUIRED
response_types
array<string>
REQUIRED
token_endpoint_auth_method
string
REQUIRED
type
string
REQUIRED

Available Values:webserver-to-serversingle-page-applicationfinancialnative

connectors
object
REQUIRED
connectors.
saml
object
connectors.saml.
consumer_service
string
REQUIRED

Your SAML SP's assertion consumer endpoint.

connectors.saml.
enabled
boolean
connectors.saml.
entity_id
string
REQUIRED
connectors.saml.
metadata_url
string

Your SAML SP's metadata URL.

connectors.saml.
relay_state
string

Application specific resource in an IDP initiated Single Sign-On scenario. In most instances this is blank.

connectors.saml.
request_binding
string
REQUIRED

Available Values:HTTP-POSTHTTP-Redirect

connectors.saml.
sign_assertions
boolean
connectors.saml.
sign_out_enabled
boolean
connectors.saml.
sign_out_url
string
connectors.saml.
signature_algorithm
string

Available Values:sha512sha256sha1

connectors.saml.
signed_requests
boolean
connectors.saml.
signing_certificate
string
connectors.saml.
mappings
object
REQUIRED
connectors.
wsfed
object
connectors.wsfed.
callback_url
string
REQUIRED

Your WS Fed application's callback uri.

connectors.wsfed.
enabled
boolean
connectors.wsfed.
realm
string
REQUIRED

Application identifier (wtrealm parameter)

connectors.wsfed.
validity
number
min60

Validity time in seconds

extra_metadata
object
REQUIRED
jwks
object
jwks.
keys
array<object>