Jump to

• Request
• Response
• Examples

Get Service Account details

get

/apiplatform/management/v1/serviceaccounts/{saId}

Returns the details of the {saId} service account. 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 and must be issued the Manage Service Account or View All Details grants for the specified service account.

Request

Supported Media Types

• application/json

Path Parameters

• saId: string
  A unique ID referencing a specific service account.

Query Parameters

• 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.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"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.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The service account's definition.

Body ()

Root Schema : GetServiceAccountResponse

Match All

Show Source

• ServiceAccount
• object ResourceLinksProperties

{
    "allOf":[
        {
            "$ref":"#/definitions/ServiceAccount"
        },
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        }
    ]
}

Nested Schema : ServiceAccount

Match All

Show Source

• object ServiceAccountId
• object ServiceAccountIdentity
• object ServiceAccountDef
• object ServiceAccountMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/ServiceAccountId"
        },
        {
            "$ref":"#/definitions/ServiceAccountIdentity"
        },
        {
            "$ref":"#/definitions/ServiceAccountDef"
        },
        {
            "$ref":"#/definitions/ServiceAccountMetadata"
        }
    ]
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : ServiceAccountId

Type: object

Show Source

• id: string
  The service account's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The service account's ID."
        }
    }
}

Nested Schema : ServiceAccountIdentity

Type: object

Show Source

• name: string
  The service account's name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The service account's name."
        }
    }
}

Nested Schema : ServiceAccountDef

Type: object

Show Source

• 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 or OAuth or WSSUsername.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The service account's description."
        },
        "type":{
            "type":"string",
            "description":"The type of service account, either <code>Basic</code> or <code>OAuth</code> or <code>WSSUsername</code>."
        },
        "configuration":{
            "type":"object",
            "description":"The service account's configuration.",
            "properties":{
                "password":{
                    "type":"string",
                    "description":"The password. On read, the password is replaced by the password key."
                },
                "tokenTransferOption":{
                    "type":"string",
                    "description":"The service account's description."
                },
                "clientId":{
                    "type":"string",
                    "description":"The client ID."
                },
                "tokenEndpointUrl":{
                    "type":"string",
                    "description":"The token endpoint URL."
                },
                "clientSecret":{
                    "type":"string",
                    "description":"The client secret. On read, the client secret is replaced by the client secret key."
                },
                "scopes":{
                    "type":"string",
                    "description":"Optional scopes."
                },
                "grant":{
                    "type":"object",
                    "description":"The OAuth grant",
                    "properties":{
                        "password":{
                            "type":"string",
                            "description":"The password. On read, the password is replaced by the password key."
                        },
                        "type":{
                            "type":"string",
                            "description":"The grant type, either <code>ClientCredentials</code> or <code>ResourceOwnerCredentials</code>."
                        },
                        "username":{
                            "type":"string",
                            "description":"The username."
                        }
                    }
                },
                "username":{
                    "type":"string",
                    "description":"The username."
                }
            }
        }
    }
}

Nested Schema : ServiceAccountMetadata

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"The user who created the service account."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the service account was created."
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the service account."
        },
        "updatedAt":{
            "type":"string",
            "description":"The date and time the service account was last updated."
        }
    }
}

Nested Schema : configuration

Type: object

The service account's configuration.

Show Source

• 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.

{
    "type":"object",
    "description":"The service account's configuration.",
    "properties":{
        "password":{
            "type":"string",
            "description":"The password. On read, the password is replaced by the password key."
        },
        "tokenTransferOption":{
            "type":"string",
            "description":"The service account's description."
        },
        "clientId":{
            "type":"string",
            "description":"The client ID."
        },
        "tokenEndpointUrl":{
            "type":"string",
            "description":"The token endpoint URL."
        },
        "clientSecret":{
            "type":"string",
            "description":"The client secret. On read, the client secret is replaced by the client secret key."
        },
        "scopes":{
            "type":"string",
            "description":"Optional scopes."
        },
        "grant":{
            "type":"object",
            "description":"The OAuth grant",
            "properties":{
                "password":{
                    "type":"string",
                    "description":"The password. On read, the password is replaced by the password key."
                },
                "type":{
                    "type":"string",
                    "description":"The grant type, either <code>ClientCredentials</code> or <code>ResourceOwnerCredentials</code>."
                },
                "username":{
                    "type":"string",
                    "description":"The username."
                }
            }
        },
        "username":{
            "type":"string",
            "description":"The username."
        }
    }
}

Nested Schema : grant

Type: object

The OAuth grant

Show Source

• password(optional): string
  The password. On read, the password is replaced by the password key.
• type(optional): string
  The grant type, either ClientCredentials or ResourceOwnerCredentials.
• username(optional): string
  The username.

{
    "type":"object",
    "description":"The OAuth grant",
    "properties":{
        "password":{
            "type":"string",
            "description":"The password. On read, the password is replaced by the password key."
        },
        "type":{
            "type":"string",
            "description":"The grant type, either <code>ClientCredentials</code> or <code>ResourceOwnerCredentials</code>."
        },
        "username":{
            "type":"string",
            "description":"The username."
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to retrieve the details of the service account by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-H "Authorization: Bearer access_token"
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 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:  Tue, 10 Oct 2017 08:38:53 GMT
Content-Length:  1883
Content-Type:  application/json
X-oracle-dms-ecid:  f102c33f-1c5b-4409-806d-03bf5706c492-00026723
X-oracle-dms-rid: 0:1
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.

            {
    "createdAt": "2018-02-05T20:49:19-0800",
    "updatedBy": "apicsadmin",
    "configuration": {
        "username": "apicsadmin"
    },
    "createdBy": "apicsadmin",
    "name": "MyGold",
    "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-05T20:49:19-0800"
}

Back to Top