users

Updates the provided userID to admin or curator status, usable by ADMINs only

put/users/{userId}/privileges

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/users/{userId}/privileges
  • Auth
    HTTP bearer

Path parameters

userIdinteger required

Request body

adminboolean
curatorboolean
metricsRobotPartner'GALAXY' | 'TERRA' | 'DNA_STACK' | 'DNA_NEXUS' | 'CGC' | 'NHLBI_BIODATA_CATALYST' | 'ANVIL' | 'CAVATICA' | 'NEXTFLOW_TOWER' | 'ELWAZI' | 'AGC' | 'TOIL' | 'OTHER' | 'ALL'
platformPartner'GALAXY' | 'TERRA' | 'DNA_STACK' | 'DNA_NEXUS' | 'CGC' | 'NHLBI_BIODATA_CATALYST' | 'ANVIL' | 'CAVATICA' | 'NEXTFLOW_TOWER' | 'ELWAZI' | 'AGC' | 'TOIL' | 'OTHER' | 'ALL'

Response

Successfully updated user to admin or curator status

avatarUrlstring
curatorboolean

Indicates whether this user is a curator. The value is always false unless requested for oneself or by an admin

idinteger
isAdminboolean

Indicates whether the user is an admin. The value is always false unless requested for oneself or by an admin

metricsRobotboolean
metricsRobotPartner'GALAXY' | 'TERRA' | 'DNA_STACK' | 'DNA_NEXUS' | 'CGC' | 'NHLBI_BIODATA_CATALYST' | 'ANVIL' | 'CAVATICA' | 'NEXTFLOW_TOWER' | 'ELWAZI' | 'AGC' | 'TOIL' | 'OTHER' | 'ALL'

Indicates whether this user is a robot that submits metrics

namestring
orcidstring
platformPartner'GALAXY' | 'TERRA' | 'DNA_STACK' | 'DNA_NEXUS' | 'CGC' | 'NHLBI_BIODATA_CATALYST' | 'ANVIL' | 'CAVATICA' | 'NEXTFLOW_TOWER' | 'ELWAZI' | 'AGC' | 'TOIL' | 'OTHER' | 'ALL'

Indicates whether this account corresponds to a platform partner

privacyPolicyVersion'NONE' | 'PRIVACY_POLICY_VERSION_2_5'
privacyPolicyVersionAcceptanceDateinteger
setupCompleteboolean
tosacceptanceDateinteger
tosversion'NONE' | 'TOS_VERSION_1' | 'TOS_VERSION_2'
tosversionAcceptanceDateinteger
userProfilesobject
usernamestring
usernameChangeRequiredboolean

Indicates whether the user is required to change their username before being allowed to do various operations on Dockstore.

Changes

No recorded changes to this operation across all 54 revisions of this API.