Users

User related APIs

一括ユーザー操作を実行する

post
Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body
actionstring · enumRequiredPossible values:
Responses
200

正常に実行されました。

application/json
post
/webapi/v2/users/bulk
POST /webapi/v2/users/bulk HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "action": "create",
  "users": [
    {
      "data": [
        {
          "key": "first_name",
          "value": "John"
        },
        {
          "key": "last_name",
          "value": "Doe"
        },
        {
          "key": "email",
          "value": "[email protected]"
        },
        {
          "key": "customer_group",
          "value": "HR"
        }
      ],
      "ownUserId": "A12345"
    }
  ]
}
200

正常に実行されました。

{
  "result": [
    {
      "ownUserId": "A12345",
      "status": "success"
    }
  ]
}

ユーザーを取得

get
Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
own_user_idstringRequired
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

成功

application/json
get
/webapi/v2/user/{own_user_id}
GET /webapi/v2/user/{own_user_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
200

成功

{
  "result": {
    "userId": "text",
    "firstName": "text",
    "lastName": "text"
  }
}
PreviousAgentsNextKnowledge_base_nodes

Last updated

Was this helpful?