RestApiCategories.platformAdministration.desc

platform_administration

2024.11

2023.03

Viya_35

2023.10

2024.10

2024.03

2024.08

2024.09

2024.12

The SAS Logon API provides the standard OAuth protocol endpoints through which clients obtain access tokens to make API calls. Terminology: <ul> <li> Client: An application making protected resource requests on behalf of the resource owner and with its authorization.</li> </ul>

SAS Logon

Changes the secret for the client that is specified in the request. Authorization: Bearer token with clients.write, clients.admin, zones.{zoneId}.admin, or equivalent (SASAdministrators) scope.

An example of a request body to change a secret.

Client Secret

clientId

An example of performing a PUT request to change a secret.

The request succeeded. The secret was updated.

Content-Type

Here is an example of an error response when the body is missing from a PUT request to change the client secret.

Error

No client exists at the requested path. The requested client could not be updated.

Change secret

The OAuth client information that is passed as input to the POST/PUT calls.

Client Input

The OAuth client information that is returned from the server response.

Client

Client Collection

A link to a related operation or resource.

Link

A list of links related to an operation or resource

Name	Type	Required	Description
clientId	string	true	The client identifier that is unique within identity zone.
oldSecret	string	false	The valid client secret before updating. This is optional if authenticated as an admin client. Otherwise, it is required.
secret	string	true	The new client secret.
changeMode	string	false	(Optional) The default is UPDATE. If change mode is set to ADD, then the new secret is added to the existing one. If the change mode is set to DELETE, then the old secret is deleted to support secret rotation. Only two client secrets are supported at any given time.

Status	Meaning	Description
200	OK	The request succeeded. The secret was updated.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
404	Not Found	No client exists at the requested path. The requested client could not be updated.

Change secret

Request Samples

Response Samples

Path Parameters

Request Body

Responses