Account partial update
Overview
Partial update of Account information
Required Privileges
auth
Restrictions
- Always handles Content-Type in the request header as application/json
- Only accepts the request body in the JSON format
- Only application/json is supported for Content-Type in the request header and the JSON format for the response body
- Response body data is not ensured if atom or xml is specified in the $format query option, although it does not result in an error
Request
Request URL
{CellURL}__ctl/Account(Name='{AccountName}')
or
{CellURL}__ctl/Account('{AccountName}')
Request Method
MERGE
Request Query
| Query Name | Overview | Effective Value | Required | Notes |
|---|---|---|---|---|
| p_cookie_peer | Cookie Authentication Value | The cookie authentication value returned from the server during authentication | No | Valid only if no Authorization header specified Specify this when cookie authentication information is to be used |
Request Header
| Header Name | Overview | Effective Value | Required | Notes |
|---|---|---|---|---|
| X-HTTP-Method-Override | Method override function | User-defined | No | If you specify this value when requesting with the POST method, the specified value will be used as a method. |
| X-Override | Header override function | ${OverwrittenHeaderName}:${Value} | No | Overwrite normal HTTP header value. To overwrite multiple headers, specify multiple X-Override headers. |
| X-Personium-RequestKey | RequestKey field value output in the event log | Single-byte alphanumeric characters, hyphens ("-"), and underscores ("_") Maximum of 128 characters | No | When not specified, default value given with ${4 digits}_${22 digits} Base64url characters format representing an UUID for each request |
| Authorization | Specifies authentication information in the OAuth 2.0 format | Bearer {AccessToken} | No | * Authentication tokens are the tokens acquired using the Authentication Token Acquisition API |
| Content-Type | Specifies the request body format | application/json | No | [application/json] by default |
| Accept | Specifies the response body format | application/json | No | [application/json] by default |
| If-Match | Specifies the target ETag value | ETag value | No | [*] by default |
| X-Personium-Credential | Password | String | No | * Follow the password restrictions of unit setting The default is as follows Number of character:6 - 32 Character type: Half size alphanumeric characters and following half-width symbol -_!$*=^`{|}~.@ |
Request Body
| Header Name | Overview | Effective Value | Required | Notes |
|---|---|---|---|---|
| Name | Account Name | Number of digits: 1 - 128 Character type: Half size alphanumeric characters and following half-width symbol (-_!$*=^`{|}~.@) However, the first character can not be specified as the first character | No | |
| Type | Account Type | basic(ID/PW authentication) oidc:google(Google OpenID Connect authentication) or divide upper case by space character | No | |
| IPAddressRange | IP address range | Specify the IP address range for which authentication is permitted Multiple specification with comma delimited, range specification by prefix notation possible When it is null, authentication is enabled with all IP addresses | No | |
| Status | status | Specify account status Refer to "Status" of Create Account | No |
Request Sample
Account name update
{
"Name": "account2"
}
Account name and Account type update
{
"Name": "account2","Type":"oidc:google"
}
Response
Response Code
204
Response Header
None
Response Body
None
Error Messages
Refer to Error Message List
cURL Command
Account name update
curl "https://cell1.unit1.example/__ctl/Account('account1')" -X MERGE -i -H \
'If-Match: *' -H 'X-Personium-Credential:password' -H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' -H \
'Accept: application/json' -d '{"Name":"account2"}'
Account name and Account type update
curl "https://cell1.unit1.example/__ctl/Account('account1')" -X MERGE -i \
-H 'If-Match: *' -H 'X-Personium-Credential:password' \
-H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' \
-H 'Accept: application/json' -d '{"Name":"account2","Type":"oidc:google"}'
Account name and Status update
curl "https://cell1.unit1.example/__ctl/Account('account1')" -X MERGE -i -H \
'If-Match: *' -H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' -H \
'Accept: application/json' -d '{"Name":"account2","Status":"deactivated"}'
Password initialization (force change)
curl "https://cell1.unit1.example/__ctl/Account('account1')" -X MERGE -i -H \
'If-Match: *' -H 'X-Personium-Credential:password' -H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' -H \
'Accept: application/json' -d '{"Status":"passwordChangeRequired"}'