Jump to

• Request
• Response

Get Users by Role

get

{baseUrl}/v1/{contractAddress}/{ordsPathPrefix}/getUsersByRole

Retrieves users assigned to the specified role. Generated from `ORDS GET /getUsersByRole`.

Request

Path Parameters

• contractAddress(required): string
  Path parameter
• ordsPathPrefix(required): string
  Path parameter

Query Parameters

• role: string

Header Parameters

• X-Service-Token(required): string
  Service token forwarded to ORDS as the Authorization header.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The queried record.

Body ()

Root Schema : schema

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "org_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    },
                    "user_id":{
                        "$ref":"#/components/schemas/ORDS_VARCHAR2"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "org_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            },
            "user_id":{
                "$ref":"#/components/schemas/ORDS_VARCHAR2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• org_id: string
• user_id: string

{
    "type":"object",
    "properties":{
        "org_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        },
        "user_id":{
            "$ref":"#/components/schemas/ORDS_VARCHAR2"
        }
    }
}

400 Response

The wrapper rejected the request before it could complete a downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

502 Response

The wrapper could not complete the downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

Default Response

ORDS upstream status, content type, and response body are passed through unchanged.

Back to Top