Skip to main content

List Users in the Workspace

GET 

/api/workspaces/:workspace_id/users/

Lists all the users that have access to the workspace. In case of non-admin users, only members of the same user groups are returned.

Request

Path Parameters

    workspace_id stringrequired

Query Parameters

    limit integer

    Number of results to return per page.

    offset integer

    The initial index from which to return the results.

Responses

Schema

    id integer
    name string
    first_name string

    Possible values: non-empty

    last_name string

    Possible values: non-empty

    username string

    Possible values: non-empty

    Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

    email email

    Possible values: non-empty

    job_title stringnullable

    Possible values: non-empty

    last_login date-time

    The last time the user logged into the environment. The value is in ISO 8601 format.

    previous_login date-time

    The second last time the user logged into the environment. The value is in ISO 8601 format.

    is_ws_deletable boolean

    Specifies whether a user can be removed from the workspace.

    access_groups integer[]

    The user groups to which the user is a member of inside the workspace.

    is_ws_admin boolean

    Specifies whether the user is a workspace admin.

    is_env_admin boolean

    Specifies whether the user is an organization admin. Defaults to false.

    last_workspace_visit date-time

    The last time the user visited the workspace (and ran a Job). The value is in ISO 8601 format.

Loading...