Update a User
put
/api/restapi/user
Send a request to this endpoint to update general information for a user.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityApplicationUserInput
Type:
object
Title:
ApiEntityApplicationUserInput
This entity represents a ApplicationUser object, a unique ApplicationUser object can be identified by the following combinations of the fields.
Show Source
- userId
- ldapGuid
-
email(required): string
Maximum Length:
320
The email address of a user. -
firstName(required): string
Maximum Length:
100
The first name of a user. -
lastName(required): string
Maximum Length:
100
The last name of a user. -
ldapGuid: string
Minimum Length:
1
Maximum Length:255
The unique identifier in the external authentication system (LDAP or IDCS). -
mobile: string
Maximum Length:
100
The mobile phone number of a user. -
phone: string
Maximum Length:
100
The phone number of a user. -
status: string
Maximum Length:
20
Allowed Values:[ "ACTIVE", "INACTIVE" ]
Determines the status of the user. When a user is inactive, they can no longer have access to login. Valid Values are ACTIVE and INACTIVE. -
title: string
Maximum Length:
25
The title of a user. -
userId: integer
(int64)
The system-generated identifier of a user.
-
userLocale: string
The language code for a user.
pt_BR
- Brazilian Portuguesenl
- Dutchen
- Englishfr
- Frenchde
- Germanit
- Italianja
- Japaneseko
- Koreanru
- Russianzh_CN
- Simplified Chinesees
- Spanishzh_TW
- Traditional Chinese
-
userProducts: array
userProducts
A list of all user product fields and values in the form of key value pairs.
-
userType: string
Allowed Values:
[ "USER", "COMPANY_RESTRICTED", "APPLICATION_ADMIN", "IDEA_SUBMITTER" ]
The type of the user.
Nested Schema : userProducts
Type:
array
A list of all user product fields and values in the form of key value pairs.
Show Source
-
Array of:
object ApiEntityUserProductInput
Title:
ApiEntityUserProductInput
Nested Schema : ApiEntityUserProductInput
Type:
object
Title:
Show Source
ApiEntityUserProductInput
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete the particular nested entry in the list of user products. A valid productName value must be provided to perform deletion. -
productId: integer
(int64)
The system-generated unique identifier of a license.
-
productName: string
Allowed Values:
[ "IDEA", "PORTFOLIO", "PROGRESS", "SCHEDULE", "TASKS" ]
The name of the license. -
userProductId: integer
(int64)
The system-generated identifier for the user product.
Response
204 Response
Successful operation with no content.
400 Response
Invalid input for the user group service.