Jump to

• Request
• Response
• Examples

Get service accounts a user can reference

get

/apiplatform/management/v1/apis/{apiId}/references/serviceaccounts

Returns all service accounts that can be referenced in policies applied to the {apiId} API.

Users requesting this resource must be assigned the API Manager role and must be issued the Manage Service Account or Reference Service grant for the specified API. Only service accounts the user is issued the Manage Service Account, or Reference Service grant for are returned.

Request

Supported Media Types

• application/json

Path Parameters

• apiId: string
  A unique ID referencing a specific API.

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"
  }

• limit(optional): integer(int32)
  Number of items to retrieve. 1 is the minumum; 128 is the maximum.

  Default Value: 128
• offset(optional): integer(int32)
  Offset the list returned results by this amount. Default is zero.

  Default Value: 0
• orderBy(optional): array
  Collection Format: csv

  Pass sorting criteria, comma separated.

  • [0]: string

  {
      "name":"orderBy",
      "in":"query",
      "description":"Pass sorting criteria, comma separated.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• 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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The collection of service accounts

Body ()

Root Schema : GetReferenceServiceAccountsResponse

Match All

Show Source

• object CollectionResponseFeature
• object CollectionResponsePagingFeature
• object GetReferenceServiceAccountsResponse-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/definitions/CollectionResponseFeature"
        },
        {
            "$ref":"#/definitions/CollectionResponsePagingFeature"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ServiceAccount"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionResponseFeature

Type: object

Show Source

• count(optional): integer(int32)
  The number of items in this collection.

{
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"The number of items in this collection."
        }
    }
}

Nested Schema : CollectionResponsePagingFeature

Type: object

Show Source

• totalResults(optional): integer(int32)
  The total number of results available. Only provided if the showTotalResults query parameter is set to true

{
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of results available. Only provided if the showTotalResults query parameter is set to true"
        }
    }
}

Nested Schema : GetReferenceServiceAccountsResponse-allOf[2]

Type: object

Show Source

• items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ServiceAccount"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: ServiceAccount

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ServiceAccount"
    }
}

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

{
    "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>."
        },
        "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."
        }
    }
}

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 all service accounts can be referenced in policies applied to the API by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-u apicsadmin:password
https://example.com/apiplatform/management/v1/apis/{apiId}/references/serviceaccounts

{apiId} is the unique Id for an API. To retrieve available API Ids, see Get APIs.

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:  Mon, 13 Mar 2017 07:24:25 GMT
Content-Length:  410
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.

   {
    "offset": 0,
    "count": 3,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/apis/100/references/serviceaccounts?offset=0=128"
        }
    ],
    "items": [
        {
            "createdAt": "2018-02-05T20:49:19-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "MyGold",
            "description": "canned service account",
            "id": "100",
            "type": "Basic",
            "updatedAt": "2018-02-09T01:03:52-0800"
        },
        {
            "createdAt": "2018-02-08T22:15:01-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Basic",
            "description": "canned service account",
            "id": "101",
            "type": "Basic",
            "updatedAt": "2018-02-08T22:15:19-0800"
        },
        {
            "createdAt": "2018-02-08T22:16:11-0800",
            "updatedBy": "apcsadmin",
            "createdBy": "apcsadmin",
            "name": "Special",
            "description": "canned service account",
            "id": "103",
            "type": "Basic",
            "updatedAt": "2018-02-08T22:16:11-0800"
        }
    ]
}

Back to Top