Skip to main content

Assign Role To User In Organization

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

Assign a role to a user in an organization.

Request​

Path Parameters

    organization_id uuidrequired

Cookie Parameters

    session any

Body

required

    user_id User Id (string)required

    The user's ID.

    organization_id uuidrequired

    The organization's ID.

    role_id uuidrequired

    The role's ID.

Responses​

Successful Response

Schema

    id uuidrequired

    Unique identifier

    created_at

    object

    Creation datetime

    anyOf

    string

    updated_at

    object

    Update datetime

    anyOf

    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

    string

    updated_at

    object

    Update datetime

    anyOf

    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

    string

    permissions

    object[]

    required

    The actual permissions of the role.

  • Array [

    • id uuidrequired

    Unique identifier

    created_at

    object

    Creation datetime

    anyOf

    string

    updated_at

    object

    Update datetime

    anyOf

    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

    string

    access Access (boolean)required

    Whether the permission is granted or not.

  • ]

Loading...