admin

Initiate an action

Starts an action with the given name.

Parameters

Name Type Required Description
name string true the action to run

Errors

StatusDescription
400

Request

put
/admin/actions
    {
  "name": "relist_jobs"
}
  

Response

    {
  "status": "202"
}
  

List administrator roles

Request

get
/admin/roles

Response

    {
  "example": [
    {
      "description": "Manage who is an administrator and what they can do.",
      "id": "full",
      "name": "Full"
    },
    {
      "description": "Manage instance settings and administrative messages.",
      "id": "settings",
      "name": "Settings"
    },
    {
      "description": "Manage users in any space. Delete any space.",
      "id": "spaces",
      "name": "Spaces"
    },
    {
      "description": "Create user accounts. Control activation of user accounts.",
      "id": "users",
      "name": "Users"
    },
    {
      "description": "Provides ability to:\n     - Create new spaces even if the `Free Spaces` setting is not enabled.\n     - Manage HMMs and common references.\n     - View all running jobs.\n     - Cancel any job.\n    ",
      "id": "base",
      "name": "Base"
    }
  ],
  "status": "200"
}
  

Find users

Returns a paginated list of users.

Request

get
/admin/users

Response

    {
  "example": {
    "items": [
      {
        "active": true,
        "administrator_role": "base",
        "b2c": null,
        "b2c_display_name": null,
        "b2c_family_name": null,
        "b2c_given_name": null,
        "b2c_oid": null,
        "force_reset": false,
        "groups": [],
        "handle": "leeashley",
        "id": "TxWalSSn",
        "last_password_change": "2023-03-20T22:46:26.151000Z",
        "permissions": {
          "cancel_job": false,
          "create_ref": false,
          "create_sample": false,
          "modify_hmm": false,
          "modify_subtraction": false,
          "remove_file": false,
          "remove_job": false,
          "upload_file": false
        },
        "primary_group": null
      },
      {
        "active": true,
        "administrator_role": "full",
        "b2c": null,
        "b2c_display_name": null,
        "b2c_family_name": null,
        "b2c_given_name": null,
        "b2c_oid": null,
        "force_reset": false,
        "groups": [],
        "handle": "zclark",
        "id": "fb085f7f",
        "last_password_change": "2023-03-20T22:46:26.151000Z",
        "permissions": {
          "cancel_job": false,
          "create_ref": false,
          "create_sample": false,
          "modify_hmm": false,
          "modify_subtraction": false,
          "remove_file": false,
          "remove_job": false,
          "upload_file": false
        },
        "primary_group": null
      }
    ]
  },
  "status": "200"
}
  

Create a user

Creates a new user.

Parameters

Name Type Required Description
force_reset boolean false forces a password reset next time the user logs in
handle string true the unique handle for the user
password string true the password for the user

Errors

StatusDescription
400 Password does not meet length requirement
403 Not permitted

Request

post
/admin/users

Response

    {
  "status": "201"
}
  

Get a user

Fetches the details of a user.

Errors

StatusDescription
404 User not found

Request

get
/admin/users/{user_id}

Response

    {
  "example": {
    "active": true,
    "administrator_role": "base",
    "b2c": null,
    "b2c_display_name": null,
    "b2c_family_name": null,
    "b2c_given_name": null,
    "b2c_oid": null,
    "force_reset": false,
    "groups": [],
    "handle": "user_handle",
    "id": "TxWalSSn",
    "last_password_change": "2023-03-20T22:46:26.151000Z",
    "permissions": {
      "cancel_job": false,
      "create_ref": false,
      "create_sample": false,
      "modify_hmm": false,
      "modify_subtraction": false,
      "remove_file": false,
      "remove_job": false,
      "upload_file": false
    },
    "primary_group": null
  },
  "status": "200"
}
  

Update a user

Parameters

Name Type Required Description
active boolean false deactivate a user
force_reset boolean false Forces a password reset next time the user logs in
groups array false Sets the IDs of groups the user belongs to
password string false the new password
primary_group integer false Sets the ID of the user's primary group

Errors

StatusDescription
404 User not found

Request

patch
/admin/users/{user_id}

Response

    {
  "example": {
    "active": true,
    "administrator_role": "base",
    "b2c": null,
    "b2c_display_name": null,
    "b2c_family_name": null,
    "b2c_given_name": null,
    "b2c_oid": null,
    "force_reset": false,
    "groups": [],
    "handle": "user_handle",
    "id": "TxWalSSn",
    "last_password_change": "2023-03-20T22:46:26.151000Z",
    "permissions": {
      "cancel_job": false,
      "create_ref": false,
      "create_sample": false,
      "modify_hmm": false,
      "modify_subtraction": false,
      "remove_file": false,
      "remove_job": false,
      "upload_file": false
    },
    "primary_group": null
  },
  "status": "200"
}
  

Set administrator role

Updates the user's administrator role.

Parameters

Name Type Required Description
role false the administrator role for the user

Errors

StatusDescription
404 User not found

Request

put
/admin/users/{user_id}/role
    {
  "role": "users",
  "user_id": "foo"
}
  

Response

    {
  "example": {
    "active": true,
    "administrator_role": "base",
    "b2c": null,
    "b2c_display_name": null,
    "b2c_family_name": null,
    "b2c_given_name": null,
    "b2c_oid": null,
    "force_reset": false,
    "groups": [],
    "handle": "user_handle",
    "id": "TxWalSSn",
    "last_password_change": "2023-03-20T22:46:26.151000Z",
    "permissions": {
      "cancel_job": false,
      "create_ref": false,
      "create_sample": false,
      "modify_hmm": false,
      "modify_subtraction": false,
      "remove_file": false,
      "remove_job": false,
      "upload_file": false
    },
    "primary_group": null
  },
  "status": "200"
}