Get Roles

Get Roles

Get a list of all roles

Request
URI
GET
https://sfo-vcf01.rainpole.io/v1/roles
COPY
Responses
200

OK

Returns PageOfRole of type(s) application/json
{
    "elements": [
        {
            "description": "string",
            "id": "string",
            "name": "string"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of Role
elements
Optional

The list of elements included in this page

pageMetadata
Optional

Represents pageable elements pagination metadata


400

Bad request

Returns ErrorResponse of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "cause": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "message": "string",
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

arguments

array of ErrorCause
cause
Optional

cause

object
context
Optional

context

string
errorCode
Optional

errorCode

string
message
Optional

message

nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken

string
remediationMessage
Optional

remediationMessage


401

Unauthorized Request

Returns ErrorResponse of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "cause": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "message": "string",
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

arguments

array of ErrorCause
cause
Optional

cause

object
context
Optional

context

string
errorCode
Optional

errorCode

string
message
Optional

message

nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken

string
remediationMessage
Optional

remediationMessage


500

Internal Server Error

Returns ErrorResponse of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "cause": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "message": "string",
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

arguments

array of ErrorCause
cause
Optional

cause

object
context
Optional

context

string
errorCode
Optional

errorCode

string
message
Optional

message

nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken

string
remediationMessage
Optional

remediationMessage