Modifies a real-name registrant.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
Ensures the idempotency of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters. If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request. |
eyJhbGciOiJIUzI1NiIsInR5cC..... |
| Name |
string |
No |
The name of the registrant. The name cannot exceed 255 characters in length. |
Zhang XX |
| DocumentType |
string |
No |
The document type of the registrant. For more information, see the appendix on document types. |
SFZ |
| DocumentCode |
string |
No |
The document number of the registrant. The number cannot exceed 50 characters in length. |
11011239900307663x |
|
string |
No |
The email address. The address cannot exceed 300 characters in length. |
example@example.com |
|
| DocumentImage |
string |
No |
The document image of the registrant (Base64-encoded). The original file size must be between 50 KB and 3 MB. |
Document image |
| Cc |
string |
No |
The country. |
China |
| State |
string |
No |
The state or province. |
Zhejiang |
| City |
string |
No |
The city. |
Hangzhou |
| Street |
string |
No |
The street address. |
XX District, XX Street |
| Phone |
string |
No |
The phone number of the registrant. The number cannot exceed 128 characters in length. If the country is China and the number is not a mobile phone number, the area code must match the city. |
13112345678 |
| RegistrantId |
string |
No |
The ID of the real-name registrant. |
2072277378616354816 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
536E9CAD-DB30-4647-AC87-AA5CC38C5382 |
| Success |
boolean |
Indicates whether the operation was successful. Valid values:
|
true |
| AccessDeniedDetail |
object |
The details of the access denial. This field is returned only when RAM authentication fails. |
|
| AuthAction |
string |
The unauthorized operation that was attempted. |
AddRspDomainServerHoldStatusForGateway |
| AuthPrincipalDisplayName |
string |
The display name of the authorization principal. |
2015555733387XXXX |
| AuthPrincipalOwnerId |
string |
The owner ID of the authorization principal. |
10469733312XXX |
| AuthPrincipalType |
string |
The identity type. |
SubUser |
| EncodedDiagnosticMessage |
string |
The encoded complete diagnostic message. |
AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ== |
| NoPermissionType |
string |
The reason for the authentication failure. Valid values:
|
ImplicitDeny |
| PolicyType |
string |
The policy type. |
DlpSend |
Examples
Success response
JSON format
{
"RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
"Success": true,
"AccessDeniedDetail": {
"AuthAction": "AddRspDomainServerHoldStatusForGateway",
"AuthPrincipalDisplayName": "2015555733387XXXX",
"AuthPrincipalOwnerId": "10469733312XXX",
"AuthPrincipalType": "SubUser",
"EncodedDiagnosticMessage": "AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "DlpSend"
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.