Update Client

Scopes

write:client

Path Parameters

client_id
string
Required

Client identifier

Request Body

client_name
string

length

1-64

Client name for displaying purposes.

description
string

length

1-256

Additional description for the client

first_party
boolean

Is client first party

Default Value: true

grant_types
array<string>

logo_uri
string

length

1-1024

logout_uris
array<string>

oidc_conformant
boolean

redirect_uris
array<string>

response_types
array<string>

token_endpoint_auth_method
string

updated_at
string

Update date in the ISO 8601 format according to universal time.

advanced
object

advanced.
pkce_required
boolean

Default Value: true

advanced.
devices
object

advanced.devices.
android
object

advanced.devices.android.
package_name
string

length

0-256

advanced.devices.android.
sha256_cert_fingerprints
array<string>

advanced.devices.
ios
object

advanced.devices.ios.
bundle_identifier
string

length

0-256

advanced.devices.ios.
team_id
string

length

0-256

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.
audiences
array<string>

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
integer

min60

Validity time in seconds

extra_metadata
object

jwks
object

jwks.
keys
array<object>

200

Response Body Schema

client_id
string
Required

length

0-256

Unique client identifier.

client_name
string
Required

length

1-64

Client name for displaying purposes.

client_secret
string
Required

length

0-256

Unique client identifier.

grant_types
array<string>
Required

logout_uris
array<string>
Required

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

description
string

length

1-256

Additional description for the client

first_party
boolean

Is client first party

Default Value: true

logo_uri
string

length

1-1024

oidc_conformant
boolean

updated_at
string

Update date in the ISO 8601 format according to universal time.

advanced
object
Required

advanced.
pkce_required
boolean

Default Value: true

advanced.
devices
object

advanced.devices.
android
object

advanced.devices.android.
package_name
string

length

0-256

advanced.devices.android.
sha256_cert_fingerprints
array<string>

advanced.devices.
ios
object

advanced.devices.ios.
bundle_identifier
string

length

0-256

advanced.devices.ios.
team_id
string

length

0-256

connectors
object
Required

connectors.
saml
object

connectors.saml.
consumer_service
string
Required

Your SAML SP's assertion consumer endpoint.

connectors.saml.
entity_id
string
Required

connectors.saml.
request_binding
string
Required

Available Values: HTTP-POSTHTTP-Redirect

connectors.saml.
enabled
boolean

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.
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.
realm
string
Required

Application identifier (wtrealm parameter)

connectors.wsfed.
audiences
array<string>

connectors.wsfed.
enabled
boolean

connectors.wsfed.
validity
integer

min60

Validity time in seconds

Update Client

Path Parameters

client_idstringRequired

Request Body

client_namestring

descriptionstring

first_partyboolean

grant_typesarray<string>

logo_uristring

logout_urisarray<string>

oidc_conformantboolean

redirect_urisarray<string>

response_typesarray<string>

token_endpoint_auth_methodstring

updated_atstring

advancedobject

advanced. pkce_requiredboolean

advanced. devicesobject

advanced.devices. androidobject

advanced.devices.android. package_namestring

advanced.devices.android. sha256_cert_fingerprintsarray<string>

advanced.devices. iosobject

advanced.devices.ios. bundle_identifierstring

advanced.devices.ios. team_idstring

connectorsobject

connectors. samlobject

connectors.saml. consumer_servicestring

connectors.saml. enabledboolean

connectors.saml. entity_idstring

connectors.saml. metadata_urlstring

connectors.saml. relay_statestring

connectors.saml. request_bindingstring

connectors.saml. sign_assertionsboolean

connectors.saml. sign_out_enabledboolean

connectors.saml. sign_out_urlstring

connectors.saml. signature_algorithmstring

connectors.saml. signed_requestsboolean

connectors.saml. signing_certificatestring

connectors.saml. mappingsobject

connectors. wsfedobject

connectors.wsfed. audiencesarray<string>

connectors.wsfed. callback_urlstring

connectors.wsfed. enabledboolean

connectors.wsfed. realmstring

connectors.wsfed. validityinteger

extra_metadataobject

jwksobject

jwks. keysarray<object>

Response Body Schema

client_idstringRequired

client_namestringRequired

client_secretstringRequired

grant_typesarray<string>Required

logout_urisarray<string>Required

redirect_urisarray<string>Required

response_typesarray<string>Required

token_endpoint_auth_methodstringRequired

typestringRequired

descriptionstring

first_partyboolean

logo_uristring

oidc_conformantboolean

updated_atstring

advancedobjectRequired

advanced. pkce_requiredboolean

advanced. devicesobject

advanced.devices. androidobject

advanced.devices.android. package_namestring

advanced.devices.android. sha256_cert_fingerprintsarray<string>

advanced.devices. iosobject

advanced.devices.ios. bundle_identifierstring

advanced.devices.ios. team_idstring

connectorsobjectRequired

connectors. samlobject

connectors.saml. consumer_servicestringRequired

connectors.saml. entity_idstringRequired

connectors.saml. request_bindingstringRequired

connectors.saml. enabledboolean

connectors.saml. metadata_urlstring

connectors.saml. relay_statestring

client_id
string
Required

client_name
string

description
string

first_party
boolean

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

updated_at
string

advanced
object

advanced.
pkce_required
boolean

advanced.
devices
object

advanced.devices.
android
object

advanced.devices.android.
package_name
string

advanced.devices.android.
sha256_cert_fingerprints
array<string>

advanced.devices.
ios
object

advanced.devices.ios.
bundle_identifier
string

advanced.devices.ios.
team_id
string

connectors
object

connectors.
saml
object

connectors.saml.
consumer_service
string

connectors.saml.
enabled
boolean

connectors.saml.
entity_id
string

connectors.saml.
metadata_url
string

connectors.saml.
relay_state
string

connectors.saml.
request_binding
string

connectors.saml.
sign_assertions
boolean

connectors.saml.
sign_out_enabled
boolean

connectors.saml.
sign_out_url
string

connectors.saml.
signature_algorithm
string

connectors.saml.
signed_requests
boolean

connectors.saml.
signing_certificate
string

connectors.saml.
mappings
object

connectors.
wsfed
object

connectors.wsfed.
audiences
array<string>

connectors.wsfed.
callback_url
string

connectors.wsfed.
enabled
boolean

connectors.wsfed.
realm
string

connectors.wsfed.
validity
integer

extra_metadata
object

jwks
object

jwks.
keys
array<object>

client_id
string
Required

client_name
string
Required

client_secret
string
Required

grant_types
array<string>
Required

logout_uris
array<string>
Required

redirect_uris
array<string>
Required

response_types
array<string>
Required

token_endpoint_auth_method
string
Required

type
string
Required

description
string

first_party
boolean

logo_uri
string

oidc_conformant
boolean

updated_at
string

advanced
object
Required

advanced.
pkce_required
boolean

advanced.
devices
object

advanced.devices.
android
object

advanced.devices.android.
package_name
string

advanced.devices.android.
sha256_cert_fingerprints
array<string>

advanced.devices.
ios
object

advanced.devices.ios.
bundle_identifier
string

advanced.devices.ios.
team_id
string

connectors
object
Required

connectors.
saml
object

connectors.saml.
consumer_service
string
Required

connectors.saml.
entity_id
string
Required

connectors.saml.
request_binding
string
Required

connectors.saml.
enabled
boolean

connectors.saml.
metadata_url
string

connectors.saml.
relay_state
string

connectors.saml.
sign_assertions
boolean

connectors.saml.
sign_out_enabled
boolean

connectors.saml.
sign_out_url
string

connectors.saml.
signature_algorithm
string