Получить список API-ключей

Список API-ключей можно получить с помощью curl-запроса.

В запросе списка API-ключей есть два параметра: фильтр (filter) и список свойств (paths). В фильтре указываются значения параметров API-ключа, которым должны соответствовать ключи из запрашиваемого списка. В списке свойств указываются параметры фильтра, которые необходимо учитывать.

Пример запроса:

curl   --location   'https://iam.api.cloud.ru/api/v1/service-accounts/credentials/api-keys?filter.service_account_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&paths=enabled%2Cservice_account_id&filter.enabled=true'   \ 
--header   'accept: application/json'   \ 
--header   'Authorization: Bearer $TOKEN'   \ 
--header   'Cookie: SERVERID=s1' 

Где:

• filter.service_account_id — идентификатор сервисного аккаунта, обязательный параметр. Если указать только этот параметр, в ответе вернется список всех API-ключей, созданных для указанного сервисного аккаунта.

• filter.enabled — флаг активности API-ключа. Если значение true — в ответе вернутся только активированные API-ключи, если false — только деактивированные.

• paths — список параметров API-ключа, которые будут использованы для фильтрации. Возможные значения: service_account_id, enabled. При этом service_account_id — обязательное значение. Значения указываются через запятую — %2C.

• $TOKEN — авторизационный токен.

Пример ответа

{ 
      "keys" :   [ 
          { 
              "id" :   "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ,
              "name" :   "api-key-test-1" ,
              "description" :   "тестовый api-key 1" ,
              "service_account_id" :   "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ,
              "products" :   [ 
                  "monaas" 
              ] ,
              "secret" :   "" ,
              "restrictions" :   { 
                  "ip_addresses" :   { 
                      "ip_addresses" :   [ 
                          "xxx.xxx.x.x" 
                      ] 
                  } ,
                  "time_range" :   { 
                      "time_slots" :   [ 
                          { 
                              "start" :   18 ,
                              "end" :   19 
                          } 
                      ] ,
                      "timezone" :   3 
                  } 
              } ,
              "enabled" :   true,
              "created_at" :   "2024-03-25T06:13:26.114149Z" ,
              "updated_at" :   "2024-03-25T06:13:26.114154Z" ,
              "expires_at" :   "2024-04-23T09:32:02.984Z" 
          } ,
          { 
              "id" :   "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ,
              "name" :   "api-key-test-2" ,
              "description" :   "тестовый api-key 2" ,
              "service_account_id" :   "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ,
              "products" :   [ 
                  "monaas" 
              ] ,
              "secret" :   "" ,
              "restrictions" :   { 
                  "ip_addresses" :   { 
                      "ip_addresses" :   [ 
                          "xxx.xxx.x.x" 
                      ] 
                  } ,
                  "time_range" :   { 
                      "time_slots" :   [ 
                          { 
                              "start" :   18 ,
                              "end" :   19 
                          } 
                      ] ,
                      "timezone" :   3 
                  } 
              } ,
              "enabled" :   true,
              "created_at" :   "2024-03-25T06:13:57.605545Z" ,
              "updated_at" :   "2024-03-25T06:13:57.605551Z" ,
              "expires_at" :   "2024-04-23T09:32:02.984Z" 
          } 
      ] 
 }