Oracle Access Governance REST APIs

Get an Account Profile

get

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

Returns account profile details linked to an orchestrated system with a given ID.

Request

Path Parameters

accountProfileId(required): string

Unique AccountProfile identifier.
orchestratedSystemId(required): string

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

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

Retrieves the Account Profile for the given id

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

Type: object

The full set of data that makes up an AccountProfile.

Show Source

accountAttributes: array accountAttributes

List of account attributes
accountUiAttributes: array accountUiAttributes

List of account attributes for UI rendering
createdBy: object IdentityReference

User details.
description(required): string

The description of the AccountProfile.
displayName(required): string

The display name of the AccountProfile.
id(required): string

The Unique Oracle ID (OCID) that is immutable on creation.
isDefault(required): boolean

Indicates if this AccountProfile is the default for this service instance.
isInUseByAccessBundle: boolean

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

User details.
orchestratedSystemId(required): string

The orchestratedSystemId of the AccountProfile.
tags: array tags

The list of tags associated with the AccountProfile.
timeCreated: string(date-time)

The time the AccountProfile was created. An RFC3339 formatted datetime string.
timeLastModified: string(date-time)

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

{
    "type":"object",
    "required":[
        "description",
        "displayName",
        "id",
        "isDefault",
        "orchestratedSystemId"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "orchestratedSystemId":{
            "type":"string",
            "description":"The orchestratedSystemId of the AccountProfile."
        },
        "displayName":{
            "type":"string",
            "description":"The display name of the AccountProfile."
        },
        "description":{
            "type":"string",
            "description":"The description of the AccountProfile."
        },
        "tags":{
            "type":"array",
            "description":"The list of tags associated with the AccountProfile.",
            "items":{
                "type":"string"
            }
        },
        "accountAttributes":{
            "type":"array",
            "description":"List of account attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
            }
        },
        "accountUiAttributes":{
            "type":"array",
            "description":"List of account attributes for UI rendering",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeData"
            }
        },
        "isDefault":{
            "type":"boolean",
            "description":"Indicates if this AccountProfile is the default for this service instance."
        },
        "isInUseByAccessBundle":{
            "type":"boolean",
            "description":"Indicates if this AccountProfile is the default for this service instance."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"The time the AccountProfile was created. An RFC3339 formatted datetime string."
        },
        "timeLastModified":{
            "type":"string",
            "format":"date-time",
            "description":"The time the AccountProfile was last updated. An RFC3339 formatted datetime string."
        },
        "createdBy":{
            "$ref":"#/definitions/IdentityReference"
        },
        "lastModifiedBy":{
            "$ref":"#/definitions/IdentityReference"
        }
    },
    "description":"The full set of data that makes up an AccountProfile."
}

Nested Schema : accountAttributes

Type: array

List of account attributes

Show Source

Array of: object OrchestratedSystemAttributeDataSummary

Orchestrated System Attributes

{
    "type":"array",
    "description":"List of account attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
    }
}

Nested Schema : accountUiAttributes

Type: array

List of account attributes for UI rendering

Show Source

Array of: object OrchestratedSystemAttributeData

Orchestrated System Attributes

{
    "type":"array",
    "description":"List of account attributes for UI rendering",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeData"
    }
}

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

Nested Schema : tags

Type: array

The list of tags associated with the AccountProfile.

Show Source

Array of: string

{
    "type":"array",
    "description":"The list of tags associated with the AccountProfile.",
    "items":{
        "type":"string"
    }
}

Nested Schema : OrchestratedSystemAttributeDataSummary

Type: object

Orchestrated System Attributes

Show Source

children: array children

nested attributes
discriminator: string

this field signify attribute field is password
isQuestion: boolean

Indicates if this Orchestrated System Attribute will be presented as a question.
name: string

Attribute name - Unique identifier
permissionType: string

Permission Type
title: string

Display Name for the attribute.
type: string

Type of attribute
values: array values

Attribute Values

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Attribute name - Unique identifier"
        },
        "title":{
            "type":"string",
            "description":"Display Name for the attribute."
        },
        "values":{
            "type":"array",
            "description":"Attribute Values",
            "items":{
                "type":"string"
            }
        },
        "type":{
            "type":"string",
            "description":"Type of attribute"
        },
        "permissionType":{
            "type":"string",
            "description":"Permission Type"
        },
        "children":{
            "type":"array",
            "description":"nested attributes",
            "items":{
                "$ref":"#/definitions/NestedAttributesSummary"
            }
        },
        "discriminator":{
            "type":"string",
            "description":"this field signify attribute field is password"
        },
        "isQuestion":{
            "type":"boolean",
            "description":"Indicates if this Orchestrated System Attribute will be presented as a question."
        }
    },
    "description":"Orchestrated System Attributes"
}

Nested Schema : children

Type: array

nested attributes

Show Source

Array of: object NestedAttributesSummary

Nested set of Orchestrated System attributes

{
    "type":"array",
    "description":"nested attributes",
    "items":{
        "$ref":"#/definitions/NestedAttributesSummary"
    }
}

Nested Schema : values

Type: array

Attribute Values

Show Source

Array of: string

{
    "type":"array",
    "description":"Attribute Values",
    "items":{
        "type":"string"
    }
}

Nested Schema : NestedAttributesSummary

Type: object

Nested set of Orchestrated System attributes

Show Source

items: array items

Orchestrated System attributes

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Orchestrated System attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
            }
        }
    },
    "description":"Nested set of Orchestrated System attributes"
}

Nested Schema : items

Type: array

Orchestrated System attributes

Show Source

Array of: object OrchestratedSystemAttributeDataSummary

Orchestrated System Attributes

{
    "type":"array",
    "description":"Orchestrated System attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary"
    }
}

Nested Schema : OrchestratedSystemAttributeData

Type: object

Orchestrated System Attributes

Show Source

children: array children

nested attributes
defaultValues: array defaultValues

Attribute Value
discriminator: string

this field signify attribute field is password
lookupType: string

LookupID for the attribute
name: string

Attribute name
permissionType: string

Permission Type
title: string

Display Name for the attribute.
type: string

Type of attribute

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Attribute name"
        },
        "type":{
            "type":"string",
            "description":"Type of attribute"
        },
        "title":{
            "type":"string",
            "description":"Display Name for the attribute."
        },
        "children":{
            "type":"array",
            "description":"nested attributes",
            "items":{
                "$ref":"#/definitions/NestedAttributes"
            }
        },
        "lookupType":{
            "type":"string",
            "description":"LookupID for the attribute"
        },
        "defaultValues":{
            "type":"array",
            "description":"Attribute Value",
            "items":{
                "type":"string"
            }
        },
        "permissionType":{
            "type":"string",
            "description":"Permission Type"
        },
        "discriminator":{
            "type":"string",
            "description":"this field signify attribute field is password"
        }
    },
    "description":"Orchestrated System Attributes"
}

Nested Schema : children

Type: array

nested attributes

Show Source

Array of: object NestedAttributes

Nested set of Orchestrated System attributes

{
    "type":"array",
    "description":"nested attributes",
    "items":{
        "$ref":"#/definitions/NestedAttributes"
    }
}

Nested Schema : defaultValues

Type: array

Attribute Value

Show Source

Array of: string

{
    "type":"array",
    "description":"Attribute Value",
    "items":{
        "type":"string"
    }
}

Nested Schema : NestedAttributes

Type: object

Nested set of Orchestrated System attributes

Show Source

items: array items

Orchestrated System attributes

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Orchestrated System attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeData"
            }
        }
    },
    "description":"Nested set of Orchestrated System attributes"
}

Nested Schema : items

Type: array

Orchestrated System attributes

Show Source

Array of: object OrchestratedSystemAttributeData

Orchestrated System Attributes

{
    "type":"array",
    "description":"Orchestrated System attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeData"
    }
}

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

Retrieves details for a specific Account Profile ID.

cURL Example

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

Example of GET command in REST Client Tool

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

Example of the Response Body

The following example shows the contents of the response body in JSON format, including<additional information>:

{
  "id": "84321700-xxxxx00000",
  "orchestratedSystemId": "da7efca4-xxxxx00000",
  "displayName": "DBUM AP 1",
  "description": "API UA",
  "tags": [],
  "accountAttributes": [
    {
      "name": "authenticationType",
      "title": "dbum.targetAccount.armd.authenticationType.title",
      "values": [
        "EXTERNAL"
      ],
      "type": "String",
      "permissionType": null,
      "children": [],
      "discriminator": null,
      "isQuestion": false
    },
    {
      "name": "defaultTablespace",
      "title": "dbum.targetAccount.armd.defaultTablespace.title",
      "values": [
        "DEV1105_CATALOG_TEXT_IND_TAB"
      ],
      "type": "String",
      "permissionType": null,
      "children": [],
      "discriminator": null,
      "isQuestion": false
    },
    {
      "name": "defaultTablespaceQuotaInMB",
      "title": "dbum.targetAccount.armd.defaultTablespaceQuotaInMB.title",
      "values": [],
      "type": "Long",
      "permissionType": null,
      "children": [],
      "discriminator": null,
      "isQuestion": true
    },
    {
      "name": "temporaryTablespace",
      "title": "dbum.targetAccount.armd.temporaryTablespace.title",
      "values": [],
      "type": "String",
      "permissionType": null,
      "children": [],
      "discriminator": null,
      "isQuestion": false
    },
    {
      "name": "profileName",
      "title": "dbum.targetAccount.armd.profileName.title",
      "values": [],
      "type": "String",
      "permissionType": null,
      "children": [],
      "discriminator": null,
      "isQuestion": false
    },
    {
      "name": "password",
      "title": "dbum.targetAccount.armd.password.title",
      "values": [],
      "type": "GuardedString",
      "permissionType": null,
      "children": [],
      "discriminator": "AccountPassword",
      "isQuestion": false
    }
  ],
  "accountUiAttributes": [
    {
      "name": "authenticationType",
      "type": "String",
      "title": "dbum.targetAccount.armd.authenticationType.title",
      "children": [],
      "lookupType": "authType",
      "permissionType": null,
      "discriminator": null
    },
    {
      "name": "defaultTablespace",
      "type": "String",
      "title": "dbum.targetAccount.armd.defaultTablespace.title",
      "children": [],
      "lookupType": "tablespace",
      "permissionType": null,
      "discriminator": null
    },
    {
      "name": "defaultTablespaceQuotaInMB",
      "type": "Long",
      "title": "dbum.targetAccount.armd.defaultTablespaceQuotaInMB.title",
      "children": [],
      "lookupType": null,
      "permissionType": null,
      "discriminator": null
    },
    {
      "name": "temporaryTablespace",
      "type": "String",
      "title": "dbum.targetAccount.armd.temporaryTablespace.title",
      "children": [],
      "lookupType": "tempTablespace",
      "permissionType": null,
      "discriminator": null
    },
    {
      "name": "profileName",
      "type": "String",
      "title": "dbum.targetAccount.armd.profileName.title",
      "children": [],
      "lookupType": "profile",
      "permissionType": null,
      "discriminator": null
    },
    {
      "name": "password",
      "type": "GuardedString",
      "title": "dbum.targetAccount.armd.password.title",
      "children": [],
      "lookupType": null,
      "permissionType": null,
      "discriminator": "AccountPassword"
    }
  ],
  "isDefault": true,
  "isInUseByAccessBundle": false,
  "timeCreated": "2025-03-21T06:19:01.234Z",
  "timeLastModified": "2025-03-21T06:19:01.234Z",
  "createdBy": {
    "id": "xxxxx00000",
    "name": "Amel MacLead"
  },
  "lastModifiedBy": {
    "id": "xxxxx00000",
    "name": "Amel MacLead"
  }
}