Get User Role

GET 
/api/v1/organizations/:organization_id/users/roles

Get the role of a user in an organization.

Request

Path Parameters

organization_id uuidrequired

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

anyOf

UserOrganizationRole

Schema for a user's role in an organization.

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

user_id User Id (string)required

The user's ID.

organization_id uuidrequired

The organization's ID.

role_id uuidrequired

The role's ID.

role

object

required

The role.

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

name Name (string)required

A name for the role.

Possible values: non-empty and <= 3000 characters

organization_id

object

required

The organization's ID.

anyOf

MOD1

string

permissions

object[]

required

The actual permissions of the role.

Array [

id uuidrequired

Unique identifier

created_at

object

Creation datetime

anyOf

MOD1

string

updated_at

object

Update datetime

anyOf

MOD1

string

name Name (string)required

A name for the permission.

Possible values: non-empty and <= 3000 characters

description

object

required

A description for the permission.

anyOf

MOD1

string

access Access (boolean)required

Whether the permission is granted or not.

]

Example (from schema)

{}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}