Skip to main content

Patch OAuth Client

This performs a targeted update to the field(s) of an OAuth client. Request will require a security scope of

  • sp:oauth-client:manage
Path Parameters
  • id string required

    The OAuth client id

    Example: ef38f94347e94562b5bb8424a56397d8
Request Body array required

A list of OAuth client update operations according to the JSON Patch standard.

The following fields are patchable:

  • tenant
  • businessName
  • homepageUrl
  • name
  • description
  • accessTokenValiditySeconds
  • refreshTokenValiditySeconds
  • redirectUris
  • grantTypes
  • accessType
  • enabled
  • strongAuthSupported
  • claimsSupported
  • op string required

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

  • path string required

    A string JSON Pointer representing the target path to an element to be affected by the operation

  • value object

    The value to be used for the operation, required for "add" and "replace" operations

    anyOf

  • string
Responses

Indicates the PATCH operation succeeded, and returns the OAuth client's new representation.


Schema
  • id string

    ID of the OAuth client

  • businessName string

    The name of the business the API Client should belong to

  • homepageUrl string

    The homepage URL associated with the owner of the API Client

  • name string

    A human-readable name for the API Client

  • description string

    A description of the API Client

  • accessTokenValiditySeconds int32

    The number of seconds an access token generated for this API Client is valid for

  • refreshTokenValiditySeconds int32

    The number of seconds a refresh token generated for this API Client is valid for

  • redirectUris string[]

    A list of the approved redirect URIs used with the authorization_code flow

  • grantTypes string[]

    Possible values: [CLIENT_CREDENTIALS, AUTHORIZATION_CODE, REFRESH_TOKEN]

    A list of OAuth 2.0 grant types this API Client can be used with

  • accessType string

    Possible values: [ONLINE, OFFLINE]

    The access type (online or offline) of this API Client

  • type string

    Possible values: [CONFIDENTIAL, PUBLIC]

    The type of the API Client (public or confidential)

  • internal boolean

    An indicator of whether the API Client can be used for requests internal to IDN

  • enabled boolean

    An indicator of whether the API Client is enabled for use

  • strongAuthSupported boolean

    An indicator of whether the API Client supports strong authentication

  • claimsSupported boolean

    An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow

  • created date-time

    The date and time, down to the millisecond, when the API Client was created

  • modified date-time

    The date and time, down to the millisecond, when the API Client was last updated

  • scope string[]

    Scopes of the API Client.

Loading...