Console
    Start free

    Update Role

    Version 4.0.25.20 (latest)

    Update information about the role with a specific id.

    Request

    PATCH /roles/{role_id}
    Datatype
    Description
    Request
    HTTP Request
    path
    HTTP Path
    Expand HTTP Path definition...
    role_id
    string
    id of role
    body
    HTTP Body
    Expand HTTP Body definition...
    body
    Role
    Expand Role definition...
    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
    permission_set_id
    string
    (Write-Only) Id of permission set
    model_set
    (Read only) Model set
    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

    Response

    200: Role

    Datatype
    Description
    (object)
    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

    404: Not Found

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

    405: Resource Can't Be Modified

    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: