Jump to

• Request
• Response

Get list of roles

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/roles

Returns a list of roles.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.

Query Parameters

• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• lifecycleState: string
  A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• sortBy: string
  The field to sort by. You can provide only one sort order. 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 ascending (`ASC`) or descending (`DESC`).

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

Header Parameters

• 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. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful opeartion. A page of role summary objects is retrieved.

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 ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : RoleCollection

Type: object

The results of a role search. It contains RoleSummary objects.

Show Source

• items(required): array items
  Maximum Number of Items: 100

  The role summaries returned.

{
    "type":"object",
    "description":"The results of a role search. It contains RoleSummary objects.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"The role summaries returned.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/RoleSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Maximum Number of Items: 100

The role summaries returned.

Show Source

• Array of: object RoleSummary
  The summary of the role.

{
    "description":"The role summaries returned.",
    "type":"array",
    "maxItems":100,
    "items":{
        "$ref":"#/definitions/RoleSummary"
    }
}

Nested Schema : RoleSummary

Type: object

The summary of the role.

Show Source

• createdBy: string
  Minimum Length: 1

  Maximum Length: 255

  The user name of the user/principal who created the role.
• description: string
  The description of the role summary.
• displayName(required): string
  Maximum Length: 255

  The role summary name. It can be changed.
• isAssigned: boolean
  The role summary is assigned to the current user or a group that the user is part of.
• key(required): string
  Minimum Length: 1

  Maximum Length: 255

  A unique key for the role summary. It cannot be changed.
• lifecycleDetails: string
  A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
• lifecycleState: string
  The current state of the role summary.
• roleType: string
  Allowed Values: [ "SYSTEM", "CUSTOM" ]

  Type of role.
• timeCreated: string(date-time)
  The time the role summary was created. An RFC3339 formatted datetime string.
• timeUpdated: string(date-time)
  The time the role summary was updated. An RFC3339 formatted datetime string.
• updatedBy: string
  Minimum Length: 1

  Maximum Length: 255

  The user name of the user/principal who updated the role.

{
    "description":"The summary of the role.",
    "type":"object",
    "required":[
        "key",
        "displayName"
    ],
    "properties":{
        "key":{
            "description":"A unique key for the role summary. It cannot be changed.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "displayName":{
            "description":"The role summary name. It can be changed.",
            "type":"string",
            "maxLength":255
        },
        "roleType":{
            "description":"Type of role.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/RoleType",
            "enum":[
                "SYSTEM",
                "CUSTOM"
            ]
        },
        "timeCreated":{
            "description":"The time the role summary was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the role summary was updated. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "isAssigned":{
            "description":"The role summary is assigned to the current user or a group that the user is part of.",
            "type":"boolean"
        },
        "createdBy":{
            "description":"The user name of the user/principal who created the role.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "updatedBy":{
            "description":"The user name of the user/principal who updated the role.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "lifecycleState":{
            "description":"The current state of the role summary.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Role/lifecycleState"
        },
        "lifecycleDetails":{
            "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.",
            "type":"string"
        },
        "description":{
            "description":"The description of the role summary.",
            "type":"string"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID 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 message.

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

Back to Top