admin

Patch an OAuth 2.0 Client

Patch an existing OAuth 2.0 Client. If you pass client_secret the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe.

OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.

patch/clients/{id}

Path parameters

idstring required

The id of the OAuth 2.0 Client.

Request body

fromstring

A JSON-pointer

opstring required

The operation to be performed

pathstring required

A JSON-pointer

valueobject

The value to be used within the operations

Example request

[
  {
    "op": "\"replace\"",
    "path": "\"/name\""
  }
]

Response

oAuth2Client

allowed_cors_originsstring[]

audiencestring[]

backchannel_logout_session_requiredboolean

Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.

backchannel_logout_uristring

RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.

client_idstring

ID is the id for this client.

client_namestring

Name is the human-readable string name of the client to be presented to the end-user during authorization.

client_secretstring

Secret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again.

client_secret_expires_atinteger

SecretExpiresAt is an integer holding the time at which the client secret will expire or 0 if it will not expire. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of expiration.

This feature is currently not supported and it's value will always be set to 0.

client_uristring

ClientURI is an URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion.

contactsstring[]

created_atstring date-time

CreatedAt returns the timestamp of the client's creation.

frontchannel_logout_session_requiredboolean

Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false.

frontchannel_logout_uristring

RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be.

grant_typesstring[]

jwksobject

jwks_uristring

URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.

logo_uristring

LogoURI is an URL string that references a logo for the client.

metadataobject

ownerstring

Owner is a string identifying the owner of the OAuth 2.0 Client.

policy_uristring

PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.

post_logout_redirect_urisstring[]

redirect_urisstring[]

registration_access_tokenstring

RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client.

registration_client_uristring

RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.

request_object_signing_algstring

JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm.

request_urisstring[]

response_typesstring[]

scopestring

Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.

sector_identifier_uristring

URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values.

subject_typestring

SubjectType requested for responses to this Client. The subject_types_supported Discovery parameter contains a list of the supported subject_type values for this server. Valid types include pairwise and public.

token_endpoint_auth_methodstring

Requested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none.

token_endpoint_auth_signing_algstring

Requested Client Authentication signing algorithm for the Token Endpoint.

tos_uristring

TermsOfServiceURI is a URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.

updated_atstring date-time

UpdatedAt returns the timestamp of the last update.

userinfo_signed_response_algstring

JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type.

Example response

{
  "metadata": "{}",
  "token_endpoint_auth_signing_alg": "token_endpoint_auth_signing_alg",
  "client_uri": "client_uri",
  "jwks": "{}",
  "logo_uri": "logo_uri",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "registration_client_uri": "registration_client_uri",
  "allowed_cors_origins": [
    "allowed_cors_origins",
    "allowed_cors_origins"
  ],
  "registration_access_token": "registration_access_token",
  "client_id": "client_id",
  "token_endpoint_auth_method": "token_endpoint_auth_method",
  "userinfo_signed_response_alg": "userinfo_signed_response_alg",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "scope": "scope",
  "request_uris": [
    "request_uris",
    "request_uris"
  ],
  "client_secret": "client_secret",
  "backchannel_logout_session_required": true,
  "backchannel_logout_uri": "backchannel_logout_uri",
  "client_name": "client_name",
  "policy_uri": "policy_uri",
  "owner": "owner",
  "audience": [
    "audience",
    "audience"
  ],
  "post_logout_redirect_uris": [
    "post_logout_redirect_uris",
    "post_logout_redirect_uris"
  ],
  "grant_types": [
    "grant_types",
    "grant_types"
  ],
  "subject_type": "subject_type",
  "redirect_uris": [
    "redirect_uris",
    "redirect_uris"
  ],
  "sector_identifier_uri": "sector_identifier_uri",
  "frontchannel_logout_session_required": true,
  "frontchannel_logout_uri": "frontchannel_logout_uri",
  "client_secret_expires_at": 0,
  "jwks_uri": "jwks_uri",
  "request_object_signing_alg": "request_object_signing_alg",
  "tos_uri": "tos_uri",
  "contacts": [
    "contacts",
    "contacts"
  ],
  "response_types": [
    "response_types",
    "response_types"
  ]
}