Get Service Accounts
/apiplatform/management/v1/serviceaccounts
Returns a collection of all service accounts the requesting user is authorized to view. The response also contains HATEOAS links to related operations.
Users requesting this resource must be assigned the API Manager, Gateway Manager, or Service Manager role. Service accounts the user is issued the Manage Service Account or View All Details grants for are returned.
Request
- application/json
-
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. -
limit(optional): integer(int32)
Number of items to retrieve.
1
is the minumum;128
is the maximum.Default Value:128
- links(optional): array
-
offset(optional): integer(int32)
Offset the list returned results by this amount. Default is zero.Default Value:
0
- orderBy(optional): array
-
q(optional): string
Pass filtering criteria, using the SCIM filter expression syntax
-
totalResults(optional): boolean
Include the total result count in the response.Default Value:
false
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
links(optional):
array links
Includes 'canonical'.
object
-
totalResults(optional):
integer(int32)
The total number of results available. Only provided if the showTotalResults query parameter is set to true
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
object
-
links(optional):
array links
Includes 'canonical'.
object
-
name:
string
The service account's name.
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
-
createdAt(optional):
string
The date and time the service account was created.
-
createdBy(optional):
string
The user who created the service account.
-
updatedAt(optional):
string
The date and time the service account was last updated.
-
updatedBy(optional):
string
The user who last updated the service account.
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.
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 retrieve details of all service accounts the requesting user is authorized to view by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X GET -u :password https://example.com/apiplatform/management/v1/serviceaccounts
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Fri, 15 Dec 2017 07:24:25 GMT Content-Length: 1702 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-00018fc1 X-oracle-dms-rid: 0 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including the ID of the service account.
{ "offset": 0, "count": 3, "limit": 128, "hasMore": false, "links": [ { "method": "GET", "rel": "self", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts?offset=0&=128" }, { "method": "GET", "rel": "canonical", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts" }, { "method": "POST", "rel": "create", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts" } ], "items": [ { "createdAt": "2018-02-05T20:49:19-0800", "updatedBy": "apicsadmin", "configuration": { "username": "" }, "createdBy": "apicsadmin", "name": "MyGold", "description": "canned service account", "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/100" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/100" }, { "templated": "true", "method": "GET", "rel": "history", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/100/history" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/100" }, { "templated": "true", "method": "PUT", "rel": "rename", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/100/identity" }, { "templated": "true", "method": "GET", "rel": "grants", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/100/grants" } ], "id": "100", "type": "Basic", "updatedAt": "2018-02-09T01:03:52-0800" }, { "createdAt": "2018-02-08T22:15:01-0800", "updatedBy": "apicsadmin", "configuration": { "username": "foo" }, "createdBy": "apicsadmin", "name": "Basic", "description": "canned service account", "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/101" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/101" }, { "templated": "true", "method": "GET", "rel": "history", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/101/history" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/101" }, { "templated": "true", "method": "PUT", "rel": "rename", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/101/identity" }, { "templated": "true", "method": "DELETE", "rel": "delete", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/101" }, { "templated": "true", "method": "GET", "rel": "grants", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/101/grants" } ], "id": "101", "type": "Basic", "updatedAt": "2018-02-08T22:15:19-0800" }, { "createdAt": "2018-02-08T22:16:11-0800", "updatedBy": "apicsadmin", "configuration": { "username": "foo" }, "createdBy": "apicsadmin", "name": "Special", "description": "canned service account", "links": [ { "templated": "true", "method": "GET", "rel": "self", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/103" }, { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/103" }, { "templated": "true", "method": "GET", "rel": "history", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/103/history" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/103" }, { "templated": "true", "method": "PUT", "rel": "rename", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/103/identity" }, { "templated": "true", "method": "DELETE", "rel": "delete", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/103" }, { "templated": "true", "method": "GET", "rel": "grants", "href": "http://example..com:7201/apiplatform/management/v1/serviceaccounts/103/grants" } ], "id": "103", "type": "Basic", "updatedAt": "2018-02-08T22:16:11-0800" } ] }
{ "offset": 0, "count": 3, "limit": 128, "hasMore": false, "links": [ { "method": "GET", "rel": "self", "href": "http://example.com:443/apiplatform/management/v1/serviceaccounts?offset=0=128" }, { "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/serviceaccounts" }, { "method": "POST", "rel": "create", "href": "http://example.com:443/apiplatform/management/v1/serviceaccounts" } ], "items": [ { "links": [ { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/serviceaccounts/100" } ], "id": "100" }, { "links": [ { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/serviceaccounts/101" } ], "id": "101" }, { "links": [ { "templated": "true", "method": "GET", "rel": "canonical", "href": "http://example.com:443/apiplatform/management/v1/serviceaccounts/102" } ], "id": "102" } ] }