Jump to

• Request
• Response
• Examples

Gets a list of Organizations

get

/access-governance/service-administration/20250331/organizations

Returns a list of Organizations with support for pagination.

Request

Query Parameters

• keywordContains: array[string]
  Collection Format: multi

  Maximum Number of Items: 5

  The list of keywords to filter on
• 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 timeUpdated is descending. Default order for name is ascending.

  Allowed Values: [ "createdBy", "displayName", "name", "timeUpdated" ]
• sortOrder: string
  The sort order to use, either 'ASC' or 'DESC'.

  Allowed Values: [ "ASC", "DESC" ]
• status: string
  A filter to return only organizations that match the give status or ALL to match all organizations.

  Allowed Values: [ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ]

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A page of Organization summary objects.

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.

Body ()

Root Schema : OrganizationCollection

Type: object

Contains summarized information about Organizations.

Show Source

• items(required): array items
  List containing summarized information about Organizations.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List containing summarized information about Organizations.",
            "items":{
                "$ref":"#/definitions/OrganizationSummary"
            }
        }
    },
    "description":"Contains summarized information about Organizations."
}

Nested Schema : items

Type: array

List containing summarized information about Organizations.

Show Source

• Array of: object OrganizationSummary
  Summarized Organization model.

{
    "type":"array",
    "description":"List containing summarized information about Organizations.",
    "items":{
        "$ref":"#/definitions/OrganizationSummary"
    }
}

Nested Schema : OrganizationSummary

Type: object

Summarized Organization model.

Show Source

• createdBy: object Info
  Generic information object.
• description: string
  Description of the Organization.
• displayName: string
  Display Name of the Organization.
• id(required): string
  Unique identifier that is immutable on creation.
• isOwner: boolean
  Boolean value checking if logged-in user is owner of this organization or not.
• membershipRule: string
  Membership Rule for the Organization.
• name: string
  Name of the Organization.
• organizationType: string
  Type of the Organization.
• primaryOwner: object User
  Owner of a resource.
• status: string
  Allowed Values: [ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ]

  Status of the Organization.
• tags: array tags
  List of tags attached to the Organization.
• timeCreated: string(date-time)
  Time when the Organization was created. An RFC3339 formatted datetime string.
• timeUpdated: string(date-time)
  Time when the Organization was last updated. An RFC3339 formatted datetime string.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier that is immutable on creation."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Organization."
        },
        "name":{
            "type":"string",
            "description":"Name of the Organization."
        },
        "description":{
            "type":"string",
            "description":"Description of the Organization."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Organization was created. An RFC3339 formatted datetime string."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the Organization was last updated. An RFC3339 formatted datetime string."
        },
        "organizationType":{
            "type":"string",
            "description":"Type of the Organization."
        },
        "createdBy":{
            "$ref":"#/definitions/Info"
        },
        "membershipRule":{
            "type":"string",
            "description":"Membership Rule for the Organization."
        },
        "status":{
            "type":"string",
            "description":"Status of the Organization.",
            "enum":[
                "ACTIVE",
                "DRAFT",
                "INACTIVE",
                "PENDING",
                "FAILED",
                "IN_PROGRESS",
                "SAVED",
                "SUCCESS",
                "TIMEOUT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/OrganizationStatus",
            "x-default-description":"ACTIVE"
        },
        "tags":{
            "type":"array",
            "description":"List of tags attached to the Organization.",
            "items":{
                "type":"string"
            }
        },
        "primaryOwner":{
            "$ref":"#/definitions/User"
        },
        "isOwner":{
            "type":"boolean",
            "description":"Boolean value checking if logged-in user is owner of this organization or not."
        }
    },
    "description":"Summarized Organization model."
}

Nested Schema : Info

Type: object

Generic information object.

Show Source

• displayName: string
  Display Name of the entity.
• id: string
  id of the entity.
• name: string
  name of the entity.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the entity."
        },
        "name":{
            "type":"string",
            "description":"name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic information object."
}

Nested Schema : User

Type: object

Owner of a resource.

Show Source

• displayName: string
  Display name of the owner.
• id: string
  Global id of the owner.
• isPrimary: boolean
  Is user a primary owner.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Global id of the owner."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the owner."
        },
        "isPrimary":{
            "type":"boolean",
            "description":"Is user a primary owner."
        }
    },
    "description":"Owner of a resource."
}

Nested Schema : tags

Type: array

List of tags attached to the Organization.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of tags attached to the Organization.",
    "items":{
        "type":"string"
    }
}

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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

Back to Top

Examples

The following example shows how to retrieve a list of organizations by submitting a GET request.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${si}/access-governance/service-administration/${version}/organizations'

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "id": "caxx69xx-19db-xxc3-b9d6-1f40xx37d54d",
      "displayName": "Database-Infra",
      "name": "Database-Infra",
      "description": "Manages core database infrastructure and provisioning",
      "timeCreated": "2025-09-04T06:36:51.001Z",
      "timeUpdated": "2025-09-04T06:36:51.001Z",
      "organizationType": "AG_ORGANIZATION",
      "createdBy": {
        "id": "globalId.8dxxefbf-ab68-4fxx-ae89-7bcc0fxxe5be.18.a84836862e0958ba29e9002afd63a7fb",
        "name": "Amel Maclead",
        "displayName": "Amel Maclead"
      },
      "membershipRule": "all { location IN AUS;USA;India }",
      "status": "ACTIVE",
      "tags": ["org", "database", "infra"],
      "primaryOwner": {
        "id": "globalId.8dxxefbf-ab68-4fxx-ae89-7bcc0fxxe5be.18.a84836862e0958ba29e9002afd63a7fb",
        "displayName": "Amel Maclead",
        "isPrimary": true
      },
      "isOwner": false
    },
    {
      "id": "03acxx38-faxx-454f-ba1f-59ba4bxx82f4",
      "displayName": "Engineering-Core",
      "name": "Engineering-Core",
      "description": "Core engineering team managing backend services and APIs",
      "timeCreated": "2025-07-21T10:32:48.765Z",
      "timeUpdated": "2025-08-29T16:23:54.324Z",
      "organizationType": "AG_ORGANIZATION",
      "createdBy": {
        "id": "globalId.8dxxefbf-ab68-4fxx-ae89-7bcc0fxxe5be.18.a84836862e0958ba29e9002afd63a7fb",
        "name": "Amel Maclead",
        "displayName": "Amel Maclead"
      },
      "membershipRule": "",
      "status": "ACTIVE",
      "tags": ["engineering", "backend"],
      "primaryOwner": {
        "id": "globalId.8dxxefbf-ab68-4fxx-ae89-7bcc0fxxe5be.18.a84836862e0958ba29e9002afd63a7fb",
        "displayName": "Amel Maclead",
        "isPrimary": true
      },
      "isOwner": false
    }
  ]
}

Note:

Save the organization ID and details to include while creating an access bundle and role.

Back to Top