Confirming Tenant Authorization
Function
Confirm authorization for a tenant.
URI
PUT /v2/servicerequest/authorizations/{authorization_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
authorization_id |
Yes |
String |
Specifies the authorization ID. Minimum length: 1 Maximum length: 32 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 Maximum length: 5000 |
X-Language |
No |
String |
Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default. Some internationalization information, such as the service ticket type and name, is displayed based on the language environment. Minimum length: 1 Maximum length: 32 |
X-Time-Zone |
No |
String |
Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default. Time-related data is processed based on the time zone of the environment. Minimum length: 1 Maximum length: 32 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
auth_detail_list |
No |
Array of TenantAgreeAuthDetailV2 objects |
Specifies the authorization details list. |
auth_effective_time |
No |
Long |
Specifies the authorization start time. Minimum value: 0 Maximum value: 9223372036854775807 |
auth_expire_time |
No |
Long |
Specifies the authorization expiration time. Minimum value: 0 Maximum value: 9223372036854775807 |
group_id |
No |
String |
Specifies the group ID. Minimum length: 0 Maximum length: 64 |
agency_id |
No |
String |
Specifies the agency ID. Minimum length: 0 Maximum length: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
port |
No |
Integer |
Specifies the port. Minimum value: 1 Maximum value: 65535 |
account |
No |
String |
Specifies the account. Minimum length: 0 Maximum length: 64 |
password |
No |
String |
Specifies the password. Minimum length: 0 Maximum length: 10240 |
auth_detail_id |
Yes |
Long |
Specifies the authorization detail ID. Minimum value: -9223372036854775808 Maximum value: 9223372036854775807 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. Minimum length: 0 Maximum length: 32 |
error_msg |
String |
Description of the error. Minimum length: 0 Maximum length: 32 |
Request Example
PUT https://{endpoint}/v2/servicerequest/authorizations/Auth-123456?group_id=123 { "auth_detail_list" : [ { "auth_detail_id" : 123, "port" : 80, "account" : "test", "password" : "test" } ], "auth_effective_time" : 123, "auth_expire_time" : 123, "group_id" : "test", "agency_id" : "test" }
Example Response
Status code: 200
Code 200 is returned if the operation is successful.
{ "auth_detail_list" : [ { "account" : "root", "auth_detail_id" : 123, "password" : "123456", "port" : 22 }, { "account" : "root", "auth_detail_id" : 123, "password" : 123456, "port" : 1234 } ], "auth_effective_time" : 1592795931000, "auth_expire_time" : 1592795931000, "group_id" : "123456", "agency_id" : "123456" }
Status Codes
Status Code |
Description |
---|---|
200 |
Code 200 is returned if the operation is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.