Jump to

• Request
• Response

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

Request Body - 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.

• userId
• email
• ldapGuid

Show Source

• 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.

  1. pt_BR - Brazilian Portuguese
  2. nl - Dutch
  3. en - English
  4. fr - French
  5. de - German
  6. it - Italian
  7. ja - Japanese
  8. ko - Korean
  9. ru - Russian
  10. zh_CN - Simplified Chinese
  11. es - Spanish
  12. zh_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.

{
    "title":"ApiEntityApplicationUserInput",
    "required":[
        "email",
        "firstName",
        "lastName"
    ],
    "type":"object",
    "properties":{
        "status":{
            "maxLength":20,
            "type":"string",
            "description":"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. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "title":{
            "maxLength":25,
            "type":"string",
            "description":"The title of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userId":{
            "type":"integer",
            "description":"The system-generated identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "phone":{
            "maxLength":100,
            "type":"string",
            "description":"The phone number of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userProducts":{
            "type":"array",
            "description":"A list of all user product fields and values in the form of key value pairs. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityUserProductInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "ldapGuid":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier in the external authentication system (LDAP or IDCS).",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "firstName":{
            "maxLength":100,
            "type":"string",
            "description":"The first name of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastName":{
            "maxLength":100,
            "type":"string",
            "description":"The last name of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userLocale":{
            "type":"string",
            "description":"The language code for a user. <ol><li><code>pt_BR</code> - Brazilian Portuguese</li><li><code>nl</code> - Dutch</li><li><code>en</code> - English</li><li><code>fr</code> - French</li><li><code>de</code> - German</li><li><code>it</code> - Italian</li><li><code>ja</code> - Japanese</li><li><code>ko</code> - Korean</li><li><code>ru</code> - Russian</li><li><code>zh_CN</code> - Simplified Chinese</li><li><code>es</code> - Spanish</li><li><code>zh_TW</code> - Traditional Chinese</li></ol>",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userType":{
            "type":"string",
            "description":"The type of the user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "USER",
                "COMPANY_RESTRICTED",
                "APPLICATION_ADMIN",
                "IDEA_SUBMITTER"
            ]
        },
        "email":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "mobile":{
            "maxLength":100,
            "type":"string",
            "description":"The mobile phone number of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ApplicationUser object, a unique ApplicationUser object can be identified by the following combinations of the fields.<ul><li>userId</li><li>email</li><li>ldapGuid</li>",
    "exampleSetFlag":false
}

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

{
    "type":"array",
    "description":"A list of all user product fields and values in the form of key value pairs. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityUserProductInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityUserProductInput

Type: object

Title: ApiEntityUserProductInput

Show Source

• 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.

{
    "title":"ApiEntityUserProductInput",
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "userProductId":{
            "type":"integer",
            "description":"The system-generated identifier for the user product.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "productId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a license.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "productName":{
            "type":"string",
            "description":"The name of the license.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "IDEA",
                "PORTFOLIO",
                "PROGRESS",
                "SCHEDULE",
                "TASKS"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the user group service.

Back to Top