Автентифікація

Як увійти в систему за допомогою облікових даних співробітника

Для роботи з DCM необхідно авторизуватися в системі.

Якщо ви використовуєте власний JWT, вам не потрібно виконувати автентифікацію через API.

Метою автентифікації є обмеження доступу до ідентифікації та інформації про обліковий запис лише для тих, кому це явно дозволено.

Для автентифікації використовуйте наступний хост URL-адреси: api-{alias}-integrate

Які кроки потрібно зробити для автентифікації?

Передумова: працівник повинен бути зареєстрований (див. функцію#create-employee).

1. Створити потік входу

Create Login Flow for Native Apps

get

This endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on. In the response you will get flow_id that will be used during the logging in on the next step.

Responses

get

HTTPcURLJavaScriptPython

GET /kratos/self-service/login/api HTTP/1.1
Host: {{url_host}}
Accept: */*

{
  "active": "password",
  "created_at": "2025-04-29T10:28:34.925Z",
  "expires_at": "2025-04-29T10:28:34.925Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "issued_at": "2025-04-29T10:28:34.925Z",
  "oauth2_login_challenge": "text",
  "oauth2_login_request": {
    "challenge": "text",
    "client": {
      "allowed_cors_origins": [
        "text"
      ],
      "audience": [
        "text"
      ],
      "authorization_code_grant_access_token_lifespan": "text",
      "authorization_code_grant_id_token_lifespan": "text",
      "authorization_code_grant_refresh_token_lifespan": "text",
      "backchannel_logout_session_required": true,
      "backchannel_logout_uri": "text",
      "client_credentials_grant_access_token_lifespan": "text",
      "client_id": "text",
      "client_name": "text",
      "client_secret": "text",
      "client_secret_expires_at": 1,
      "client_uri": "text",
      "contacts": [
        "text"
      ],
      "created_at": "2025-04-29T10:28:34.925Z",
      "frontchannel_logout_session_required": true,
      "frontchannel_logout_uri": "text",
      "grant_types": [
        "text"
      ],
      "implicit_grant_access_token_lifespan": "text",
      "implicit_grant_id_token_lifespan": "text",
      "jwks": null,
      "jwks_uri": "text",
      "jwt_bearer_grant_access_token_lifespan": "text",
      "logo_uri": "text",
      "metadata": null,
      "owner": "text",
      "policy_uri": "text",
      "post_logout_redirect_uris": [
        "text"
      ],
      "redirect_uris": [
        "text"
      ],
      "refresh_token_grant_access_token_lifespan": "text",
      "refresh_token_grant_id_token_lifespan": "text",
      "refresh_token_grant_refresh_token_lifespan": "text",
      "registration_access_token": "text",
      "registration_client_uri": "text",
      "request_object_signing_alg": "text",
      "request_uris": [
        "text"
      ],
      "response_types": [
        "text"
      ],
      "scope": "text",
      "sector_identifier_uri": "text",
      "subject_type": "text",
      "token_endpoint_auth_method": "text",
      "token_endpoint_auth_signing_alg": "text",
      "tos_uri": "text",
      "updated_at": "2025-04-29T10:28:34.925Z",
      "userinfo_signed_response_alg": "text"
    },
    "oidc_context": {
      "acr_values": [
        "text"
      ],
      "display": "text",
      "id_token_hint_claims": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "login_hint": "text",
      "ui_locales": [
        "text"
      ]
    },
    "request_url": "text",
    "requested_access_token_audience": [
      "text"
    ],
    "requested_scope": [
      "text"
    ],
    "session_id": "text",
    "skip": true,
    "subject": "text"
  },
  "refresh": true,
  "request_url": "text",
  "requested_aal": "aal0",
  "return_to": "text",
  "type": "text",
  "ui": {
    "action": "text",
    "messages": [
      {
        "context": {},
        "id": 1,
        "text": "text",
        "type": "info"
      }
    ],
    "method": "text",
    "nodes": [
      {
        "attributes": {
          "autocomplete": "email",
          "disabled": true,
          "label": {
            "context": {},
            "id": 1,
            "text": "text",
            "type": "info"
          },
          "name": "text",
          "node_type": "text",
          "onclick": "text",
          "pattern": "text",
          "required": true,
          "type": "text",
          "value": null
        },
        "group": "default",
        "messages": [
          {
            "context": {},
            "id": 1,
            "text": "text",
            "type": "info"
          }
        ],
        "meta": {
          "label": {
            "context": {},
            "id": 1,
            "text": "text",
            "type": "info"
          }
        },
        "type": "text"
      }
    ]
  },
  "updated_at": "2025-04-29T10:28:34.925Z"
}

1. Авторизуватися

Submit a Login Flow

post

Use this endpoint to complete a login flow.

Query parameters

flowstringRequired

The Login Flow ID

The value for this parameter comes from flow URL Query parameter sent to your application (e.g. /login?flow=abcde).

Header parameters

CookiestringOptional

HTTP Cookies

When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.

Body

application/jsonapplication/x-www-form-urlencoded

one ofOptional

or

or

or

or

Responses

post

HTTPcURLJavaScriptPython

POST /kratos/self-service/login?flow={{id}}?flow=text HTTP/1.1
Host: {{url_host}}
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "csrf_token": "text",
  "identifier": "text",
  "method": "text",
  "password": "text"
}

application/jsonapplication/x-www-form-urlencoded

{
  "...": null,
  "session_token": "text"
}

У тілі запиту необхідно вказати параметри користувача (e-mail, пароль), які вказано при реєстрації.

Важливо, тіло повинно надсилатись у форматі x-www-form-urlencoded.

Приклад:

curl --location 'https://api.xxx.processing-stage.dcm.systems/kratos/self-service/login?flow=xxx' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'csrf_token=xxx' \
--data-urlencode 'identifier=[e-mail]' \
--data-urlencode 'method=password' \
--data-urlencode 'password=xxx'

У разі успішної відповіді в тілі відповіді отримується параметрsession_token.

Токен сеансу потрібно надіслати в заголовок авторизації HTTP для всіх інших запитів API (не застосовується, якщо використовується #jwt-by-bank:

    Authorization: bearer ${session-token}