Skip to main content
PATCH
Update an OAuth client

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required
Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
method
Available options:
GET
mode
enum<string>
default:refresh_token
Available options:
password,
client_credentials,
refresh_token,
access_token,
custom_payload,
jwt_bearer
tokenUrl
string
Pattern: ^(https?):\/\/[^\s$.?#].([^\s]|\x20)*$
Example:

"https://login.salesforce.com/services/oauth2/token"

authorizeUrl
string
Pattern: ^(https?):\/\/[^\s$.?#].([^\s]|\x20)*$
Example:

"https://login.salesforce.com/services/oauth2/authorize"

clientId
string
clientSecret
string
write-only
scopes
string[]
customPayload
object
Example:

"{ payload: { query: { access_type: 'offline' } } }"

accessTokenPath
string
accessTokenHeader
string
default:authorization
Example:

"x-shopify-access-token"

accessTokenHeaderPrefix
string
Example:

"google"

tokenExpiration
number
configuration
object

Response

Ok

status
enum<string>
required
Available options:
success
program
string
required
version
string
required
datetime
string
required
message
string
required
data
object
required
code
number