Updates the profile of the specified citizen user.
Scope | users Deprecated scope name: update_citizenaccess_citizens |
App Type | All |
Authorization Type | Access token |
URI | /v4/citizenaccess/citizens/{id}?lang={lang} |
HTTP Method | PUT |
Automation Version(s) | 7.3.3.4 |
Field or Parameter | Type | Required | Values | Description | Automation Version |
---|---|---|---|---|---|
id | string | Yes | � | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
lang | String | No | � | Indicates the language applied. | 7.3.3.4 |
string | No | � | The citizen user's email address. | 7.3.3.4 | |
id | long | No | � | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
loginName | string | No | � | The citizen user's login name. | 7.3.3.4 |
mobilePhone | string | No | � | The citizen user's 10-digit cell phone number. | 7.3.3.4 |
mobilePhoneCountryCode | string | No | � | The country code for the cell phone number. | 7.3.3.4 |
questions[] | questions{} | No | � | The security question for password reset. | 7.3.3.4 |
receiveSMS | string | No | Y | N | Indicates whether or not the user prefers to receive SMS messages. | 7.3.3.4 |
registerDate | dateTime | No | � | The citizen user's registration date. | 7.3.3.4 |
role | string | No | CONTRACT_INSPECTOR | CITIZEN | AUTH_AGENT_CLERK | AUTH_AGENT | SELF_CERTIFIED_INSPECTOR | The citizen user's role: CONTRACT_INSPECTOR, CITIZEN, AUTH_AGENT_CLERK, AUTH_AGENT, SELF_CERTIFIED_INSPECTOR. | 7.3.3.4 |
Field | Type | Description | Automation Version |
---|---|---|---|
result | result{} | � | 7.3.3.4 |
result.email | string | The citizen user's email address. | 7.3.3.4 |
result.id | long | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
result.loginName | string | The citizen user's login name. | 7.3.3.4 |
result.mobilePhone | string | The citizen user's 10-digit cell phone number. | 7.3.3.4 |
result.mobilePhoneCountryCode | string | The country code for the cell phone number. | 7.3.3.4 |
result.questions[] | result.questions{} | The security question for password reset. | 7.3.3.4 |
result.receiveSMS | string | Indicates whether or not the user prefers to receive SMS messages. | 7.3.3.4 |
result.registerDate | dateTime | The citizen user's registration date. | 7.3.3.4 |
result.role | string | The citizen user's role: CONTRACT_INSPECTOR, CITIZEN, AUTH_AGENT_CLERK, AUTH_AGENT, SELF_CERTIFIED_INSPECTOR. | 7.3.3.4 |
status | integer | The record status. | 7.3.3.4 |