Add User to Users of a Setting

Request

POST <REST API URL>/settings/{setting id}/users?fields=string

Parameter	Description
`fields`	Optional. Returns only the specified subset of the fields for each User. Use Fields Syntax to define the subset.

Request Body

user

extends authorityHolder

extended by projectTeamMember


  {
    "login": string, 
    "banned": boolean, 
    "banReason": string, 
    "guest": boolean, 
    "avatar": avatar, 
    "profile": profile, 
    "contacts": [contact, ...], 
    "groups": [userGroup, ...], 
    "transitiveGroups": [userGroup, ...], 
    "teams": [projectTeam, ...], 
    "transitiveTeams": [projectTeam, ...], 
    "details": [details, ...], 
    "VCSUserNames": [vcsUserName, ...], 
    "sshPublicKeys": [sshPublicKey, ...], 
    "licenses": [license, ...], 
    "creationTime": calendar, 
    "lastAccessTime": calendar, 
    "refreshTokens": [refreshToken, ...], 
    "permanentTokens": [permanentToken, ...], 
    "approvedScopes": [approvedScope, ...], 
    "applicationPasswords": [applicationPassword, ...], 
    "favoriteProjects": [project, ...], 
    "endUserAgreementConsent": endUserAgreementConsent, 
    "eraseTimestamp": calendar, 
    "twoFactorAuthentication": twoFactorAuthentication, 
    "requiredTwoFactorAuthentication": boolean, 
    "pendingTwoFactorAuthentication": twoFactorAuthenticationSecret, 
    "webauthnDevice": webauthnDevice, 
      "id": string /* from authorityHolder */, 
      "aliasIds": [string, ...] /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */, 
      "sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */
  }

Response

Response Code	Meaning
200 OK	Successful request.
400 Bad Request	At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.
403 Forbidden	The requester has no access to the requested resource.
404 Not Found	The requested resource was not found.
500 Internal Server Error	Failed to process request because of the server error. For details, check the error message in the response.

Response body


  {
    "login": string, 
    "banned": boolean, 
    "banReason": string, 
    "guest": boolean, 
    "avatar": avatar, 
    "profile": profile, 
    "contacts": [contact, ...], 
    "groups": [userGroup, ...], 
    "transitiveGroups": [userGroup, ...], 
    "teams": [projectTeam, ...], 
    "transitiveTeams": [projectTeam, ...], 
    "details": [details, ...], 
    "VCSUserNames": [vcsUserName, ...], 
    "sshPublicKeys": [sshPublicKey, ...], 
    "licenses": [license, ...], 
    "creationTime": calendar, 
    "lastAccessTime": calendar, 
    "refreshTokens": [refreshToken, ...], 
    "permanentTokens": [permanentToken, ...], 
    "approvedScopes": [approvedScope, ...], 
    "applicationPasswords": [applicationPassword, ...], 
    "favoriteProjects": [project, ...], 
    "endUserAgreementConsent": endUserAgreementConsent, 
    "eraseTimestamp": calendar, 
    "twoFactorAuthentication": twoFactorAuthentication, 
    "requiredTwoFactorAuthentication": boolean, 
    "pendingTwoFactorAuthentication": twoFactorAuthenticationSecret, 
    "webauthnDevice": webauthnDevice, 
      "id": string /* from authorityHolder */, 
      "aliasIds": [string, ...] /* from authorityHolder */, 
      "aliases": [alias, ...] /* from authorityHolder */, 
      "name": string /* from authorityHolder */, 
      "projectRoles": [projectRole, ...] /* from authorityHolder */, 
      "transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */, 
      "sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */
  }

Last modified: 17 February 2020