Skip to main content

Partial Update API User

PATCH 
/api-users/:id/

Request​

Path Parameters

    id stringrequired

Body

    name string

    Possible values: <= 60 characters

    Name of the user.

    title string

    Possible values: [ceo, cto, cso, seceng, dev, devop, manager, other, ``]

    Job title:

    • ceo - Chief Executive Officer
    • cto - Chief Technology Officer
    • cso - Chief Security Officer
    • seceng - Security engineer
    • dev - Developer
    • devop - Developer Operations
    • manager - Manager
    • other - Other
    active boolean

    Default value: true

    If true, the user can authenticate to Probely to interact with apps and the API.
    If false, the user's access to Probely's apps and API is blocked.
    Defaults to true.

    labels

    object[]

  • Array [

    • name stringrequired

    Possible values: <= 255 characters

    Name of the label.
    The maximum length is 255 characters.

    color string

    Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

    Color of the label, in RGB hexadecimal format prefixed with "#".
    For example, "#00FF00" for green.

  • ]

Responses​

Schema

    id stringrequired

    A unique Base58 value identifying this object.

    name stringrequired

    Possible values: <= 60 characters

    Name of the user.

    changed_by

    object

    required

    User who last made changes.

    id stringrequired

    A unique Base58 value identifying this object.

    email email

    Possible values: <= 254 characters

    Email of the user.

    name stringrequired

    Possible values: <= 60 characters

    Name of the user.

    changed date-timerequired

    Date and time of the last change, in ISO 8601 UTC format.
    For example, "2023-08-09T13:27:43.8208302".

    active boolean

    Default value: true

    If true, the user can authenticate to Probely to interact with apps and the API.
    If false, the user's access to Probely's apps and API is blocked.
    Defaults to true.

    labels

    object[]

    required

  • Array [

    • id stringrequired

    A unique Base58 value identifying this object.

    name stringrequired

    Possible values: <= 255 characters

    Name of the label.
    The maximum length is 255 characters.

    color string

    Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

    Color of the label, in RGB hexadecimal format prefixed with "#".
    For example, "#00FF00" for green.

    changed_by

    object

    required

    User who last made changes.

    id stringrequired

    A unique Base58 value identifying this object.

    email email

    Possible values: <= 254 characters

    Email of the user.

    name stringrequired

    Possible values: <= 60 characters

    Name of the user.

    changed date-timerequired

    Date and time of the last change, in ISO 8601 UTC format.
    For example, "2023-08-09T13:27:43.8208302".

  • ]

    • user_roles

    object[]

    Roles of the user.

  • Array [

    • id stringrequired

    A unique Base58 value identifying this object.

    role

    object

    required

    Return serializer_class with all fields as read_only except key. The key is the field use to retrieve the object in to_internal_value.

    This is for the drf-spectacular documentation generation.

    id string

    A unique Base58 value identifying this object.

    name stringrequired

    Possible values: <= 255 characters

    Role's name.

    scope

    object

    required

    tier stringrequired

    target

    object

    id stringrequired

    A unique Base58 value identifying this object.

    name stringrequired
    url urirequired

    Target URL.

    team

    object

    id stringrequired

    A unique Base58 value identifying this object.

    name stringrequired

  • ]

    • is_apiuser booleanrequired

    If true, it is an app that interacts with Probely through the API.
    If false, it is a human who interacts with Probely through our web interface.
    Defaults to false."

    key stringrequired
Loading...