Update an ORDS OAuth client
put
/ords/rest/clients/{id}
Updates an ORDS OAuth client.
Request
Path Parameters
-
id(required): integer
ID for specific OAuth client.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
allowed_origins: string
A comma-separated list of URL prefixes. If the list is empty, any existing origins are removed.
-
description: string
Description of the purpose of the client, displayed to the end user during the approval phase of three-legged OAuth. May be null if p_grant_type is client_credentials; otherwise, must not be null.
-
grant_type: string
Must be one of authorization_code, implicit, or client_credentials.
-
logo_data: string
the image in base64 format for use in the show code.
-
logo_type: string
the extension of the logo image to be used in the show code.
-
name(required): string
Name for the client, displayed to the end user during the approval phase of three-legged OAuth. Must be unique.
-
privilege_names(required): string
List of comma-separated privileges that the client wants to access.
-
redirect_uri: string
Client-controlled URI to which redirect containing an OAuth access token or error will be sent. May be null if p_grant_type is client_credentials; otherwise, must not be null.
-
role_names: string
Is a string of privilege names
-
support_email: string
The email where end users can contact the client for support.
-
support_uri: string
The URI where end users can contact the client for support. Example: http://www.myclientdomain.com/support/
Response
Supported Media Types
- application/json
200 Response
Details of the ORDS OAuth client that has been successfully updated.
400 Response
No name, description or support_email parameter provided or A role name or privilege name does not exist or The list of allowed origins or privilege name is too big or A privilege name is too long.
404 Response
OAuth client does not exist
409 Response
An oauth client with that name already exists.