Mengkueri detail konsumen tempat gerbang melakukan operasi otentikasi.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
mse:GetGatewayAuthConsumerDetail |
get |
*Gateway
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| GatewayUniqueId |
string |
Yes |
ID unik gerbang. |
gw-1a4ab101d5924b6f92c5ec98a84***** |
| Id |
integer |
Yes |
ID konsumen. |
120 |
| AcceptLanguage |
string |
No |
Bahasa tanggapan. Nilai valid:
|
zh |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The ID of the request. |
316F5F64-F73D-42DC-8632-01E308B6**** |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
| Code |
integer |
The status code. A value of 200 is returned if the request is successful. |
200 |
| ErrorCode |
string |
The error code that is returned. |
mse-100-000 |
| HttpStatusCode |
integer |
The HTTP status code returned. |
200 |
| Message |
string |
The error message returned. |
The request is successfully processed. |
| DynamicCode |
string |
The dynamic part in the error message. |
code |
| DynamicMessage |
string |
The dynamic part in the error message. This parameter is used to replace the **%s** variable in the ErrMessage parameter. Catatan
If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid. |
The specified parameter is invalid. |
| Data |
object |
The data returned. |
|
| Id |
integer |
The ID of the consumer. |
12 |
| Name |
string |
The name of the consumer. |
test |
| ConsumerStatus |
boolean |
The status of the consumer. Valid values:
|
true |
| PrimaryUser |
string |
The creator. |
123 |
| GatewayUniqueId |
string |
The unique ID of the gateway. |
gw-7ea3da97b96543e19f6c597cd4a9**** |
| Type |
string |
The authentication type. Valid values:
|
JWT |
| GmtCreate |
string |
The time when the consumer authentication record was created. |
2031-03-30 02:35:12 |
| GmtModified |
string |
The time when the consumer authentication record was modified. |
2023-02-01 14:17:57 |
| Description |
string |
The description. |
Description |
| EncodeType |
string |
The encryption type. Valid values:
|
RSA |
| Jwks |
string |
The JWT public key. The JSON format is supported. |
{ "keys": [ { "e": "AQAB", "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ", "kty": "RSA", "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ" } ] } |
| TokenName |
string |
The names of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as |
Authorization |
| TokenPass |
boolean |
Specifies whether to enable pass-through. |
true |
| TokenPosition |
string |
The positions of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as |
HEADER |
| TokenPrefix |
string |
The prefixes of the parameters that are required to verify each token. By default, each token is prefixed with Bearer and stored in the Authorization header, such as |
Bearer |
| KeyName |
string |
The name of the key used for JWT-based identity authentication. |
iss |
| KeyValue |
string |
The value of the key used for JWT-based identity authentication. |
abcd |
| ResourceList |
array<object> |
The resource list. |
|
|
object |
The resource list. |
||
| Id |
integer |
The ID of the authorized resource for the consumer. |
16 |
| ConsumerId |
integer |
The consumer ID. |
123 |
| RouteId |
integer |
The ID of the route. |
3458 |
| RouteName |
string |
The name of the route. |
test |
| ResourceStatus |
boolean |
The resource authorization state. Valid values:
|
true |
| GatewayUniqueId |
string |
The unique ID of the gateway. |
gw-4822033a8513496fa10f05c934f***** |
| GmtCreate |
string |
The time when the resource associated with the consumer authentication record was created. |
2022-12-06 01:38:03 |
| GmtModified |
string |
The time when the resource associated with the consumer authentication record was modified. |
2022-12-06 01:38:03 |
Contoh
Respons sukses
JSONformat
{
"RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
"Success": true,
"Code": 200,
"ErrorCode": "mse-100-000",
"HttpStatusCode": 200,
"Message": "The request is successfully processed.\n",
"DynamicCode": "code",
"DynamicMessage": "The specified parameter is invalid.",
"Data": {
"Id": 12,
"Name": "test",
"ConsumerStatus": true,
"PrimaryUser": "123",
"GatewayUniqueId": "gw-7ea3da97b96543e19f6c597cd4a9****",
"Type": "JWT",
"GmtCreate": " 2031-03-30 02:35:12",
"GmtModified": "2023-02-01 14:17:57",
"Description": "Description\n",
"EncodeType": "RSA",
"Jwks": "{\n \"keys\": [\n {\n \"e\": \"AQAB\",\n \"kid\": \"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\",\n \"kty\": \"RSA\",\n \"n\": \"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\"\n }\n ]\n}",
"TokenName": "Authorization",
"TokenPass": true,
"TokenPosition": "HEADER",
"TokenPrefix": "Bearer ",
"KeyName": "iss",
"KeyValue": "abcd",
"ResourceList": [
{
"Id": 16,
"ConsumerId": 123,
"RouteId": 3458,
"RouteName": "test",
"ResourceStatus": true,
"GatewayUniqueId": "gw-4822033a8513496fa10f05c934f*****",
"GmtCreate": "2022-12-06 01:38:03",
"GmtModified": "2022-12-06 01:38:03"
}
]
}
}Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IllegalRequest | Invalid request:%s | Invalid request: %s |
| 400 | InvalidParameter | Parameter error:%s | Request parameter error: %s |
| 500 | InternalError | Console error. Try again later:%s | Console error. Try again later: %s |
| 403 | NoPermission | You are not authorized to perform this operation:%s | You do not have the permission to use this interface:%s |
| 404 | NotFound | Not found:%s | The resource does not exist:%s |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.