Для улучшения работы сайта мы используем файлы cookies. Оставаясь на сайте, вы соглашаетесь с политикой обработки персональных данных.

/identity/mfa/method/okta/

Конечная точка '/identity/mfa/method/okta' предназначена для управления поведением MFA Okta в StarVault.

1. Настройка метода MFA Okta

Эта конечная точка определяет метод MFA типа Okta.

Метод Путь

POST

/identity/mfa/method/okta/:method_id

1.1. Параметры

  • method_id (string: "") - необязательный UUID для указания при обновлении существующего метода.

  • method_name (string) - уникальное имя-идентификатор для этого метода MFA.

  • username_format (string) - форматная строка для сопоставления имен Identity с именами методов MFA. Значения для подстановки должны быть заключены в {{}}. Например, "{{identity.entity.name}}@example.com". Если оставить пустым, поле Name сущности Entity используется без изменений.

  • org_name (string: <required>) - название организации для использования в API Okta.

  • api_token (string: <required>) - API-ключ Okta.

  • base_url (string) - если указан, будет использоваться как базовый домен для API-запросов. Примеры: okta.com, oktapreview.com, okta-emea.com.

  • primary_email (bool: false) - если установлено, имя пользователя будет совпадать только с основным email аккаунта.

Пример тела запроса:
{
  "username_format": "{{identity.entity.aliases.auth_userpass_1793464a.name}}",
  "org_name": "dev-262778",
  "api_token": "0081u7KrReNkzmABZJAP2oDyIXccveqx9vIOEyCZDC"
}
Пример запроса:
$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/identity/mfa/method/okta
$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/identity/mfa/method/okta/1db034b5-81f1-4a2b-8c2b-0f51ed0bd9fc

2. Чтение метода MFA Okta

Эта конечная точка запрашивает конфигурацию MFA типа Okta для заданного имени метода.

Метод Путь

GET

/identity/mfa/method/okta/:id

2.1. Параметры

  • id (string: <required>) - UUID метода MFA.

Пример запроса:
$ curl \
    --header "X-Vault-Token: ..." \
    --request GET \
    http://127.0.0.1:8200/v1/identity/mfa/method/okta/1db034b5-81f1-4a2b-8c2b-0f51ed0bd9fc
Пример ответа:
{
  "data": {
    "api_token": "0081u7KrReNkzmABZJAP2oDyIXccveqx9vIOEyCZDC",
    "id": "1db034b5-81f1-4a2b-8c2b-0f51ed0bd9fc",
    "name": "my_okta",
    "org_name": "dev-262778",
    "type": "okta",
    "username_format": "{{identity.entity.aliases.auth_userpass_1793464a.name}}"
  }
}

3. Удаление метода MFA Okta

Эта конечная точка удаляет метод MFA Okta. Методы MFA можно удалять только если они не используются в настройках входа (login enforcement).

Метод Путь

DELETE

/identity/mfa/method/okta/:id

3.1. Параметры

  • id (string: <required>) - UUID метода MFA.

Пример запроса:
$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    http://127.0.0.1:8200/v1/identity/mfa/method/okta/1db034b5-81f1-4a2b-8c2b-0f51ed0bd9fc

4. Список методов MFA Okta

Эта конечная точка выводит список видимых методов MFA Okta.

Метод Путь

LIST

/identity/mfa/method/okta

Пример запроса:
$ curl \
    --header "X-Vault-Token: ..." \
    --request LIST \
    http://127.0.0.1:8200/v1/identity/mfa/method/okta
Пример ответа:
{
  "data": {
    "keys": [
      "1db034b5-81f1-4a2b-8c2b-0f51ed0bd9fc"
    ]
  }
}