...
Makes changes to an existing external personal identity.
HTTP method | URI scheme |
---|---|
PUT | /server/external-personal-identity/{personalIdentityId} |
Parameters
Type | Name | Description | Qualification | Schema |
---|---|---|---|---|
Path | vpersonalIdentityId | The ID of the external personal identity to update. | Required | string |
Body | request | Request body parameters, see schema for details. | Required |
Responses
HTTP code | Common messages | Description | Schema |
---|---|---|---|
200 | The updated external personal identity. | ||
400 | The application with the specified key could not be found | String | |
Invalid role ID format | This error message is be returned when
|
Note: |
It is not necessarily related to a role and its ID. | String | |
Input not valid: External personal identity ID must match the external personal identity ID in the REST path. | String | |
Input not valid: First name and last name must always be specified for an external personal identity. | String | |
Input not valid: State must be specified when updating an external personal identity. | String | |
Company ID is not part of identity ID. | String | |
Input not valid: Changing state of an external personal identity from 'INVITED' to ' |
<%1>' is not allowed. | Note: |
<%1> can be replaced by either ACTIVE or DEACTIVATED. | String |
Input not valid: Changing state of an external personal identity from ' |
<%1>' to 'INVITED' is not allowed. |
Note: <%1> can be replaced by either ACTIVE or DEACTIVATED. | String | |
Unknown error | This error message is returned when
| String |
500 | An unexpected error occurred: Type definition |
error <%1> | This error message can be returned if one or more parameters are of the wrong type. See ExternalPersonalIdentity for details. | String |
An unexpected error occurred: JSON parse |
error <%1> | This error message can be returned if one or more parameters are of the wrong type. See ExternalPersonalIdentity for details. | String |
Security
Type | Name |
---|---|
apiKey |