Update a Service Account
/apiplatform/management/v1/serviceaccounts/{saId}
Updates the {saId}
service account.
Users requesting this resource must be assigned the Service Manager role and must be issued the Manage Service Account grant for the specified service account.
Request
- application/json
-
saId: string
A unique ID referencing a specific service account.
object
-
configuration(optional):
object configuration
The service account's configuration.
-
description(optional):
string
The service account's description.
-
type(optional):
string
The type of service account, either
Basic
orOAuth
orWSSUsername
.
object
-
clientId(optional):
string
The client ID.
-
clientSecret(optional):
string
The client secret. On read, the client secret is replaced by the client secret key.
-
grant(optional):
object grant
The OAuth grant
-
password(optional):
string
The password. On read, the password is replaced by the password key.
-
scopes(optional):
string
Optional scopes.
-
tokenEndpointUrl(optional):
string
The token endpoint URL.
-
tokenTransferOption(optional):
string
The service account's description.
-
username(optional):
string
The username.
object
-
password(optional):
string
The password. On read, the password is replaced by the password key.
-
type(optional):
string
The grant type, either
ClientCredentials
orResourceOwnerCredentials
. -
username(optional):
string
The username.
Response
- application/json
200 Response
400 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
403 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to update the {saId} service account by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X PUT
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @serviceaccupdate-put.json
https://example.com/apiplatform/management/v1/serviceaccounts/{saId}
where {saId}
is the unique Id of the service account. To retrieve the available service accounts, see Get Service Accounts
Example of Request Body
The following shows an example of the request body, included with the request above in a file named serviceaccupdate-put
. The attributes you supply will replace the attributes in the service account definition, except for the name
attribute.
{ "name": "basic", "description": "canned service account", "type": "Basic", "configuration": { "username": "apicsadmin" } }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Sun, 22 Oct 2017 08:34:10 GMT X-oracle-dms-ecid: 49d14691-2176-4c99-aed3-38438604f528-00001e4e X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0