Lista os pareamentos de dispositivos PolarClaw.
Experimente agora
Testar
Autorização RAM
Sintaxe da solicitação
POST HTTP/1.1
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ApplicationId |
string |
Sim |
O ID do aplicativo. |
pa-************** |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Esquema da resposta. |
||
| RequestId |
string |
O ID da solicitação. |
A7E6A8FD-C50B-46B2-BA85-D8B8D3****** |
| Message |
string |
A mensagem da resposta. |
successful |
| Code |
integer |
O código de status da resposta. |
200 |
| ApplicationId |
string |
O ID do aplicativo. |
pa-************** |
| Pending |
array<object> |
Uma lista de solicitações de pareamento pendentes. |
|
|
object |
Detalhes de uma solicitação de pareamento pendente. |
||
| PairRequestId |
string |
O ID da solicitação de pareamento. |
test-1778647932986 |
| DeviceId |
string |
O ID exclusivo do dispositivo. |
device-784x37k0vko734fk |
| PublicKey |
string |
A chave pública Ed25519. |
test-pubkey-base64url |
| DisplayName |
string |
O nome de exibição do dispositivo. |
test |
| Platform |
string |
O sistema operacional. |
linux |
| DeviceFamily |
string |
A família do dispositivo. |
server |
| ClientId |
string |
O ID do cliente. |
cli |
| ClientMode |
string |
O modo do cliente. |
cli |
| Role |
string |
A função do dispositivo. |
operator |
| Roles |
array |
A lista de funções. |
|
|
string |
A função do dispositivo. |
operator |
|
| Scopes |
array |
A lista de escopos de permissão. |
|
|
string |
Um escopo de permissão. |
operator.read |
|
| RemoteIp |
string |
O endereço IP remoto do solicitante. |
127.0.0.1 |
| Silent |
boolean |
Indica se este é um pareamento silencioso. |
false |
| IsRepair |
boolean |
Indica se a solicitação é para reparar um pareamento existente. |
false |
| Ts |
integer |
O timestamp da solicitação de pareamento, em milissegundos Unix. |
1778660347550 |
| Paired |
array<object> |
Uma lista de dispositivos pareados. |
|
|
object |
Detalhes de um dispositivo pareado. |
||
| DeviceId |
string |
O ID exclusivo do dispositivo. |
f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c |
| DisplayName |
string |
O nome de exibição do dispositivo. |
empty |
| Platform |
string |
O sistema operacional. |
linux |
| DeviceFamily |
string |
A família do dispositivo. |
empty |
| ClientId |
string |
O ID do cliente. |
cli |
| ClientMode |
string |
O modo do cliente. |
cli |
| Role |
string |
A função do dispositivo. |
operator |
| Scopes |
array |
A lista de escopos de permissão. |
|
|
string |
Um escopo de permissão. |
operator.admin |
|
| CreatedAtMs |
integer |
A hora em que o pareamento do dispositivo foi criado, em milissegundos Unix. |
1778659807727 |
| LastSeenAtMs |
integer |
A hora em que o dispositivo esteve ativo pela última vez, em milissegundos Unix. |
1778659807727 |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Pending": [
{
"PairRequestId": "test-1778647932986",
"DeviceId": "device-784x37k0vko734fk",
"PublicKey": "test-pubkey-base64url",
"DisplayName": "test",
"Platform": "linux",
"DeviceFamily": "server",
"ClientId": "cli",
"ClientMode": "cli",
"Role": "operator",
"Roles": [
"operator"
],
"Scopes": [
"operator.read"
],
"RemoteIp": "127.0.0.1",
"Silent": false,
"IsRepair": false,
"Ts": 1778660347550
}
],
"Paired": [
{
"DeviceId": "f92620d6bea04f65d48cf603c57b367c97e837c1ab9f6d78f741f477e99d857c",
"DisplayName": "empty",
"Platform": "linux",
"DeviceFamily": " empty",
"ClientId": "cli",
"ClientMode": "cli",
"Role": "operator",
"Scopes": [
"operator.admin"
],
"CreatedAtMs": 1778659807727,
"LastSeenAtMs": 1778659807727
}
]
}
Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.