Console
    Start free

    Set User Roles

    Version 4.0.25.20 (latest)

    Set roles of the user with a specific id.

    Request

    PUT /users/{user_id}/roles
    Datatype
    Description
    Request
    HTTP Request
    path
    HTTP Path
    Expand HTTP Path definition...
    user_id
    string
    Id of user
    body
    HTTP Body
    Expand HTTP Body definition...
    body
    string[]
    query
    HTTP Query
    Expand HTTP Query definition...
    fields
    string
    Requested fields.

    Response

    200: Roles of user.

    Datatype
    Description
    (array)
    Role []
    can
    object
    Operations the current user is able to perform on this object
    id
    string
    Unique Id
    name
    string
    Name of Role
    permission_set
    (Read only) Permission set
    Expand PermissionSet definition...
    can
    object
    Operations the current user is able to perform on this object
    all_access
    boolean
    built_in
    boolean
    id
    string
    Unique Id
    name
    string
    Name of PermissionSet
    permissions
    string[]
    url
    string
    Link to get this item
    permission_set_id
    string
    (Write-Only) Id of permission set
    model_set
    (Read only) Model set
    Expand ModelSet definition...
    can
    object
    Operations the current user is able to perform on this object
    all_access
    boolean
    built_in
    boolean
    id
    string
    Unique Id
    models
    string[]
    name
    string
    Name of ModelSet
    url
    string
    Link to get this item
    model_set_id
    string
    (Write-Only) Id of model set
    url
    string
    Link to get this item
    users_url
    string
    Link to get list of users with this role

    400: Bad Request

    Datatype
    Description
    (object)
    message
    string
    Error details
    documentation_url
    string
    Documentation link

    403: Permission Denied

    Datatype
    Description
    (object)
    message
    string
    Error details
    documentation_url
    string
    Documentation link

    404: Not Found

    Datatype
    Description
    (object)
    message
    string
    Error details
    documentation_url
    string
    Documentation link

    422: Validation Error

    Datatype
    Description
    (object)
    message
    string
    Error details
    Expand ValidationErrorDetail definition...
    field
    string
    Field with error
    code
    string
    Error code
    message
    string
    Error info message
    documentation_url
    string
    Documentation link
    documentation_url
    string
    Documentation link

    429: Too Many Requests

    Datatype
    Description
    (object)
    message
    string
    Error details
    documentation_url
    string
    Documentation link
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: