Oracle Access Governance REST APIs

Get a list of Account Profiles

get

/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}/accountProfiles

Returns details of all available account profiles associated with a given orchestrated system, with support for pagination.

Request

Path Parameters

orchestratedSystemId(required): string

The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.

Query Parameters

isDefaultOnly: boolean

Minimum Length: 1

Maximum Length: 255

Parameter to request only the default AccountProfile be returned.

Default Value: false
keywordContains: array[string]

Collection Format: multi

Maximum Number of Items: 5

The list of keywords to filter on from the following fields: displayName, description.
limit: integer

Minimum Value: 1

Maximum Value: 1000

The maximum number of items to return.

Default Value: 10
page: string

Minimum Length: 1

A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
sortBy: string

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Default Value: timeCreated

Allowed Values: [ "timeCreated", "displayName" ]
sortOrder: string

The sort order to use, either 'ASC' or 'DESC'.

Allowed Values: [ "ASC", "DESC" ]

Header Parameters

opc-request-id: string

The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Response

Supported Media Types

application/json

200 Response

A list of Account Profile summaries

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : AccountProfileCollection

Type: object

Results of an AccountProfile search. Contains a list of AccountProfileSummary items.

Show Source

items(required): array items

List of AccountProfileSummary items.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of AccountProfileSummary items.",
            "items":{
                "$ref":"#/definitions/AccountProfileSummary"
            }
        }
    },
    "description":"Results of an AccountProfile search. Contains a list of AccountProfileSummary items."
}

Nested Schema : items

Type: array

List of AccountProfileSummary items.

Show Source

Array of: object AccountProfileSummary

Summary of the AccountProfile, used when returning lists.

{
    "type":"array",
    "description":"List of AccountProfileSummary items.",
    "items":{
        "$ref":"#/definitions/AccountProfileSummary"
    }
}

Nested Schema : AccountProfileSummary

Type: object

Summary of the AccountProfile, used when returning lists.

Show Source

displayName(required): string

AccountProfile Identifier, can be renamed
id(required): string

Unique identifier that is immutable on creation
isDefault(required): boolean

Indicates if this AccountProfile is the default for this service instance.
lastModifiedBy(required): object IdentityReference

User details.
timeLastModified(required): string(date-time)

The time the AccountProfile was last updated. An RFC3339 formatted datetime string

{
    "type":"object",
    "required":[
        "displayName",
        "id",
        "isDefault",
        "lastModifiedBy",
        "timeLastModified"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation"
        },
        "displayName":{
            "type":"string",
            "description":"AccountProfile Identifier, can be renamed"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Indicates if this AccountProfile is the default for this service instance."
        },
        "timeLastModified":{
            "type":"string",
            "format":"date-time",
            "description":"The time the AccountProfile was last updated. An RFC3339 formatted datetime string"
        },
        "lastModifiedBy":{
            "$ref":"#/definitions/IdentityReference"
        }
    },
    "description":"Summary of the AccountProfile, used when returning lists."
}

Nested Schema : IdentityReference

Type: object

User details.

Show Source

id(required): string

The Id for AG Identity
name(required): string

The Display name AG Identity

{
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Id for AG Identity"
        },
        "name":{
            "type":"string",
            "description":"The Display name AG Identity"
        }
    },
    "description":"User details."
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Default Response

Unknown Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Examples

The following example shows how to retrieve a list of Account Profiles associated with an Access Bundle.

cURL Example GET

curl -i -X \
 GET \
   -H \
 "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/service-administration/${version}/orchestratedSystems/${orchestratedSystemId}/accountProfiles'

Sample GET Command using the REST Client Tool

${service-instance-url}/access-governance/service-administration/${version}/orchestratedSystems/${orchestratedSystemId}/accountProfiles

Example of the Response Code

You'll receive a 200 OK Response Code with the following Response body:

{
  "items" : [ {
    "id" : "84321700-1a93-4cf2-9226-1xxxxxxxxxxx8",
    "displayName" : "dbum API",
    "isDefault" : true,
    "timeLastModified" : "2025-03-25T06:19:01.234Z",
    "lastModifiedBy" : {
      "id" : "globalId.125123c3-eedc-4d6a-b6d4-6c0f6537bad2.18.0xxxxxxxxxx4aa046b3ceb16a",
      "name" : "Amel Maclead"
    }
  } ]
}

Note:

If you get a 200 OK response with no items, then it indicates that no account profiles are associated with the given Orchestrated system.