---
updatedAt: 2025-08-15T15:45:24.000Z
agentTools:
  projectIndex: https://docs.arcadia.com/v1.0-Utility-Cloud/llms.txt
---

# List Roles

Get a list of the assignable roles

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Utility Cloud",
    "description": "Utility Cloud",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.urjanet.com/"
    }
  ],
  "paths": {
    "/roles": {
      "get": {
        "tags": [
          "User Management"
        ],
        "description": "Get a list of the assignable roles",
        "operationId": "List Roles",
        "summary": "List Roles",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedPublicRoleResource"
                }
              }
            }
          }
        },
        "security": [
          {
            "BearerAuth": []
          },
          {
            "UnifiedAuth": []
          },
          {
            "APIKey": []
          }
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "x-amazon-apigateway-api-key-source": "AUTHORIZER",
  "x-amazon-apigateway-binary-media-types": [
    "application/pdf",
    "application/zip",
    "application/octet-stream"
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "UnifiedAuth": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "x-amazon-apigateway-authtype": "custom",
        "x-amazon-apigateway-authorizer": {
          "authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:291789168161:function:${stageVariables.authenticatorFunctionName}/invocations",
          "authorizerCredentials": "arn:aws:iam::291789168161:role/${stageVariables.authenticatorRoleName}",
          "authorizerResultTtlInSeconds": 300,
          "type": "token"
        }
      },
      "APIKey": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    },
    "schemas": {
      "PageMetadata": {
        "type": "object",
        "properties": {
          "number": {
            "type": "integer",
            "format": "int64"
          },
          "size": {
            "type": "integer",
            "format": "int64"
          },
          "totalElements": {
            "type": "integer",
            "format": "int64"
          },
          "totalPages": {
            "type": "integer",
            "format": "int64"
          }
        },
        "title": "PageMetadata"
      },
      "PagedPublicRoleResource": {
        "required": [
          "_embedded",
          "_links",
          "page"
        ],
        "type": "object",
        "properties": {
          "_embedded": {
            "properties": {
              "roles": {
                "items": {
                  "$ref": "#/components/schemas/PublicRoleResource"
                },
                "type": "array"
              }
            },
            "type": "object"
          },
          "_links": {
            "properties": {
              "first": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "last": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "next": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              },
              "prev": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            },
            "type": "object"
          },
          "page": {
            "$ref": "#/components/schemas/PageMetadata"
          }
        },
        "title": "PagedPublicRoleResource"
      },
      "PublicRoleResource": {
        "required": [
          "createdBy",
          "createdDate",
          "lastModifiedBy",
          "lastModifiedDate",
          "name"
        ],
        "type": "object",
        "properties": {
          "_links": {
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "href": {
                    "type": "string"
                  }
                }
              }
            },
            "type": "object"
          },
          "createdBy": {
            "type": "string",
            "description": "User that created this role"
          },
          "createdDate": {
            "description": "Date that this role was created",
            "type": "string",
            "format": "date-time"
          },
          "lastModifiedBy": {
            "description": "User that most recently modified this role",
            "type": "string"
          },
          "lastModifiedDate": {
            "description": "Date this role was most recently modified",
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "description": "Name of the role",
            "type": "string"
          }
        },
        "title": "PublicRoleResource"
      }
    }
  },
  "tags": [
    {
      "name": "User Management"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```