Skip to content
PalomPalomAtlas

List Roles

GET
/api/v1/workspaces/{workspace_id}/roles
curl --request GET \
  --url https://example.com/api/v1/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roles

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
Workspace Id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Workspaces List Roles
Array<object>
WorkspaceRoleSummary
object
id
required
Id
string format: uuid
workspace_id
required
Workspace Id
string format: uuid
role
required
WorkspaceRoleName
string
Allowed values: READER MEMBER MANAGER
grant_match
required
Grant Match
object
key
additional properties
any
matched_principals
required
Matched Principals
Array<object>
MatchedPrincipal
object
id
required
Id
string
name
required
Name
string
type
required
PrincipalType
string
Allowed values: USER API
created_by
required
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
[
  {
    "role": "READER",
    "matched_principals": [
      {
        "type": "USER"
      }
    ]
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}