Jump to

• Request
• Response

Get role details

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}

Returns detailed information about a role.

Request

Path Parameters

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

  Maximum Length: 255

  The unique key of the Role.

Query Parameters

• roleScope: string
  The scope of roles to be returned. Defaults to USER.

  Allowed Values: [ "USER", "ADMIN", "MEMBER_OF" ]

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 operation. Detailed role information is retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : Role

Type: object

Role details.

Show Source

• assignees: array assignees
  Maximum Number of Items: 100

  The users and groups this role is assigned to.
• 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.
• displayName: string
  Maximum Length: 255

  The role name. It can be changed.
• isAssigned: boolean
  The role 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. 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
  Allowed Values: [ "ACTIVE" ]

  The state of the role.
• roleType: string
  Allowed Values: [ "SYSTEM", "CUSTOM" ]

  Type of role.
• timeCreated: string(date-time)
  The time the role was created. An RFC3339 formatted datetime string.
• timeUpdated: string(date-time)
  The time the Role 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":"Role details.",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"Role",
        "ocidEntityType":"Role",
        "activeLifecycleStates":[
            "active"
        ],
        "deletedLifecycleStates":[
            "deleted"
        ],
        "getOperationId":"GetRole",
        "adLocality":"regional"
    },
    "required":[
        "key"
    ],
    "properties":{
        "key":{
            "description":"A unique key for the role. It cannot be changed.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "displayName":{
            "description":"The role 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 was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the Role was updated. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "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
        },
        "isAssigned":{
            "description":"The role is assigned to the current user or a group that the user is part of.",
            "type":"boolean"
        },
        "assignees":{
            "description":"The users and groups this role is assigned to.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/RoleAssignee"
            }
        },
        "lifecycleState":{
            "description":"The state of the role.",
            "type":"string",
            "enum":[
                "ACTIVE"
            ]
        },
        "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.",
            "type":"string"
        }
    }
}

Nested Schema : assignees

Type: array

Maximum Number of Items: 100

The users and groups this role is assigned to.

Show Source

• Array of: object RoleAssignee
  The user/principal/role the role can be assigned to.

{
    "description":"The users and groups this role is assigned to.",
    "type":"array",
    "maxItems":100,
    "items":{
        "$ref":"#/definitions/RoleAssignee"
    }
}

Nested Schema : RoleAssignee

Type: object

The user/principal/role the role can be assigned to.

Show Source

• target(required): string
  The OCID for a principal or role.
• targetName: string
  The name for a principal or role.
• type(required): string
  Allowed Values: [ "USER", "ROLE", "GROUP" ]

  assignee type.

{
    "type":"object",
    "description":"The user/principal/role the role can be assigned to.",
    "required":[
        "type",
        "target"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"assignee type.",
            "x-obmcs-top-level-enum":"#/definitions/RoleAssigneeType",
            "enum":[
                "USER",
                "ROLE",
                "GROUP"
            ]
        },
        "target":{
            "type":"string",
            "description":"The OCID for a principal or role."
        },
        "targetName":{
            "type":"string",
            "description":"The name for a principal or role."
        }
    }
}

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