Sign in
oAuth2

Patch OAuth 2.0 Client

Patch an existing OAuth 2.0 Client using JSON Patch. 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/admin/clients/{id}

Path parameters

idstring required

The id of the OAuth 2.0 Client.

Request body

fromstring

This field is used together with operation "move" and uses JSON Pointer notation.

Learn more about JSON Pointers.

opstring required

The operation to be performed. One of "add", "remove", "replace", "move", "copy", or "test".

pathstring required

The path to the target path. Uses JSON pointer notation.

Learn more about JSON Pointers.

valuestring

The value to be used within the operations.

Learn more about JSON Pointers.

Example request

[
  {
    "from": "/name",
    "op": "replace",
    "path": "/name",
    "value": "foobar"
  }
]

Response

oAuth2Client

allowed_cors_originsstring[]
audiencestring[]
authorization_code_grant_access_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

authorization_code_grant_id_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

authorization_code_grant_refresh_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

backchannel_logout_session_requiredboolean

OpenID Connect Back-Channel Logout Session Required

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

OpenID Connect Back-Channel Logout URI

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

client_credentials_grant_access_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

client_idstring

OAuth 2.0 Client ID

The ID is autogenerated and immutable.

client_namestring

OAuth 2.0 Client Name

The human-readable name of the client to be presented to the end-user during authorization.

client_secretstring

OAuth 2.0 Client Secret

The secret will be included in the create request as cleartext, and then never again. The secret is kept in hashed format and is not recoverable once lost.

client_secret_expires_atinteger

OAuth 2.0 Client Secret Expires At

The field is currently not supported and its value is always 0.

client_uristring

OAuth 2.0 Client URI

ClientURI is a 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

OAuth 2.0 Client Creation Date

CreatedAt returns the timestamp of the client's creation.

frontchannel_logout_session_requiredboolean

OpenID Connect Front-Channel Logout Session Required

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

OpenID Connect Front-Channel Logout URI

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[]
implicit_grant_access_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

implicit_grant_id_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

{"stackTrail":"components:schemas:oAuth2Client:properties:jwks","oasType":"schema","type":"unknown","description":"OAuth 2.0 Client JSON Web Key Set\n\nClient's JSON Web Key Set [JWK] document, passed by value. The semantics of the jwks parameter are the same as\nthe jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter\nis intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for\ninstance, by native applications that might not have a location to host the contents of the JWK Set. If a Client\ncan use jwks_uri, it MUST NOT use jwks. One significant downside of jwks is that it does not enable key rotation\n(which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0 [OpenID.Core]). The jwks_uri and jwks\nparameters MUST NOT be used together."}
jwks_uristring

OAuth 2.0 Client JSON Web Key Set URL

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.

jwt_bearer_grant_access_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

logo_uristring

OAuth 2.0 Client Logo URI

A URL string referencing the client's logo.

{"stackTrail":"components:schemas:oAuth2Client:properties:metadata","oasType":"schema","type":"unknown","title":"JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger."}
ownerstring

OAuth 2.0 Client Owner

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

policy_uristring

OAuth 2.0 Client Policy URI

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[]
refresh_token_grant_access_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

refresh_token_grant_id_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

refresh_token_grant_refresh_token_lifespanstring

Specify a time duration in milliseconds, seconds, minutes, hours.

registration_access_tokenstring

OpenID Connect Dynamic Client Registration Access Token

RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client using Dynamic Client Registration.

registration_client_uristring

OpenID Connect Dynamic Client Registration URL

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

request_object_signing_algstring

OpenID Connect Request Object Signing Algorithm

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

OAuth 2.0 Client Scope

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

OpenID Connect Sector Identifier URI

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

OpenID Connect Subject Type

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

OAuth 2.0 Token Endpoint Authentication Method

Requested Client Authentication method for the Token Endpoint. The options are:

client_secret_post: (default) Send client_id and client_secret as application/x-www-form-urlencoded in the HTTP body. client_secret_basic: Send client_id and client_secret as application/x-www-form-urlencoded encoded in the HTTP Authorization header. private_key_jwt: Use JSON Web Tokens to authenticate the client. none: Used for public clients (native apps, mobile apps) which can not have secrets.

token_endpoint_auth_signing_algstring

OAuth 2.0 Token Endpoint Signing Algorithm

Requested Client Authentication signing algorithm for the Token Endpoint.

tos_uristring

OAuth 2.0 Client Terms of Service URI

A URL string pointing 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

OAuth 2.0 Client Last Update Date

UpdatedAt returns the timestamp of the last update.

userinfo_signed_response_algstring

OpenID Connect Request Userinfo Signed Response Algorithm

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",
  "jwt_bearer_grant_access_token_lifespan": "jwt_bearer_grant_access_token_lifespan",
  "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"
  ],
  "refresh_token_grant_access_token_lifespan": "refresh_token_grant_access_token_lifespan",
  "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",
  "authorization_code_grant_id_token_lifespan": "authorization_code_grant_id_token_lifespan",
  "authorization_code_grant_refresh_token_lifespan": "authorization_code_grant_refresh_token_lifespan",
  "client_credentials_grant_access_token_lifespan": "client_credentials_grant_access_token_lifespan",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "scope": "scope1 scope-2 scope.3 scope:4",
  "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"
  ],
  "authorization_code_grant_access_token_lifespan": "authorization_code_grant_access_token_lifespan",
  "post_logout_redirect_uris": [
    "post_logout_redirect_uris",
    "post_logout_redirect_uris"
  ],
  "grant_types": [
    "grant_types",
    "grant_types"
  ],
  "subject_type": "subject_type",
  "refresh_token_grant_refresh_token_lifespan": "refresh_token_grant_refresh_token_lifespan",
  "redirect_uris": [
    "redirect_uris",
    "redirect_uris"
  ],
  "sector_identifier_uri": "sector_identifier_uri",
  "frontchannel_logout_session_required": true,
  "frontchannel_logout_uri": "frontchannel_logout_uri",
  "refresh_token_grant_id_token_lifespan": "refresh_token_grant_id_token_lifespan",
  "implicit_grant_id_token_lifespan": "implicit_grant_id_token_lifespan",
  "client_secret_expires_at": 0,
  "implicit_grant_access_token_lifespan": "implicit_grant_access_token_lifespan",
  "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"
  ]
}

Changes