latestOpenAPI 3.0.32026-08-10234358.4 KB

3d5d69795558

Roles

List roles

Retrieve a list of roles for the specified account, including both account-specific roles and Firefly-managed (system-wide) roles. Firefly-managed roles have account_id as empty and are marked with fireflyManaged=true. For Firefly-managed roles, attached_users and team_names are filtered to show only those from the requesting account.

get/user-service/roles

Query parameters

limitinteger

Maximum number of roles to return

offsetinteger

Number of roles to skip

searchstring

Search term to filter roles by name or description

Response

Array of roles

total_countinteger

Total number of roles matching the filter criteria

Example response

{
  "roles": [
    {
      "integrationIds": [
        "integration-123",
        "integration-456"
      ],
      "providers": [
        "aws",
        "azure",
        "gcp"
      ],
      "scopes": [
        {
          "scope_id": 4,
          "scope_name": "inventory:read"
        }
      ]
    }
  ],
  "total_count": 42
}