Jump to

• Request
• Response

Get Members of a Role

get

/process/api/v1/data-access/roles/{id}/members

Fetches a paginated list of members of a role in the data access control service.

Request

Path Parameters

• id(required): string
  Role ID

Query Parameters

• limit: integer(int32)
  The numbers of items to return. If this parameter is omitted, the default value 25 is set.

  Examples

  Select an example default value

• offset: integer(int64)
  The number of items to skip before starting to collect the result set.

  Examples

  Select an example Default offset value Skip first 10 elements

• orderBy: string
  This query parameter specifies the order by clause. The value must follow the format of fieldName[:(asc/desc)][,fieldName[:(asc/desc)]]*.

  Examples

  Select an example ascending order descending order complex order

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : PageableRoleMemberResponse

Type: object

Title: PageableRoleMemberResponse

Defines PageableRoleMemberResponse

Show Source

• items: array items
• totalPages: integer
• totalResults: integer

{
    "title":"PageableRoleMemberResponse",
    "description":"Defines PageableRoleMemberResponse",
    "additionalProperties":false,
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        },
        "totalPages":{
            "type":"integer"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RoleMember"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object RoleMember
  Title: RoleMember

  Defines Member of the Role

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RoleMember"
    }
}

Nested Schema : RoleMember

Type: object

Title: RoleMember

Defines Member of the Role

Show Source

• createdOn: string
  Title: Created time

  Created time
• identityId(required): string
  Title: The user or group identityId

  The user or group identityId, OCID value
• links: array links
• name: string
  Title: User or Group name

  User or Group name
• roleId: string
  Title: The roleId

  The unique role ID
• type(required): string
  Title: The type of the principal

  Default Value: USER

  Allowed Values: [ "USER", "GROUP" ]

  Type of the member: USER ot GROUP

{
    "type":"object",
    "title":"RoleMember",
    "description":"Defines Member of the Role",
    "additionalProperties":false,
    "required":[
        "identityId",
        "type"
    ],
    "properties":{
        "roleId":{
            "type":"string",
            "title":"The roleId",
            "description":"The unique role ID"
        },
        "identityId":{
            "type":"string",
            "title":"The user or group identityId",
            "description":"The user or group identityId, OCID value"
        },
        "name":{
            "type":"string",
            "title":"User or Group name",
            "description":"User or Group name"
        },
        "type":{
            "title":"The type of the principal",
            "description":"Type of the member: USER ot GROUP",
            "type":"string",
            "enum":[
                "USER",
                "GROUP"
            ],
            "default":"USER"
        },
        "createdOn":{
            "type":"string",
            "title":"Created time",
            "description":"Created time"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

• code: integer
  Minimum Value: 100

  Maximum Value: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

400 Response

Bad request

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

404 Response

Not found

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

429 Response

Too many requests

500 Response

Internal server error

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

503 Response

Too many exceptions or too slow requests

Back to Top