この API を呼び出して、アクセストークンに基づいてユーザー情報をクエリします。
サポートされているエディション | Enterprise Dedicated Edition |
サービスエンドポイントと承認
サービスエンドポイントを取得し、API リクエスト構文の
<domain>を エンドポイント に置き換えます。アクセストークン を取得します。
organizationIdを取得します。 Lingma コンソールに移動し、 の下の [基本情報] ページで組織 ID を確認します。
製品 | リソース | 必要な権限 |
組織設定 | ユーザー | 読み取り専用 |
リクエスト構文
GET https://{domain}/oapi/v1/platform/userリクエストヘッダー
パラメーター | タイプ | 必須 | 説明 | 例 |
| 文字列 | はい | アクセストークン。 | pt-0fh3****0fbG_35af****0484 |
リクエストパラメーター
なし
リクエスト例
curl -X 'GET' \
'https://{domain}/oapi/v1/platform/user' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 |
- | オブジェクト | ||
| 文字列 | ユーザーが作成された日時。 | 2023-03-22T12:44:50.048Z |
| 文字列 | ユーザーが削除された日時。 | 2023-03-22T12:44:50.048Z |
| 文字列 | ユーザーのメールアドレス。 | test****@example.com |
| 文字列 | ユーザー ID。 | 99d1****6124 |
| 文字列 | 最後にログインした組織。 | 99d1****6124 |
| 文字列 | ユーザーの表示名。 | Example Username |
| 文字列 | ユーザーのニックネームまたはエイリアス。 | Example Nickname |
| 文字列 | 従業員 ID。 | 123**** |
| 配列 [文字列] | ユーザーの部署。 | ["99d1****6124"] |
| 文字列 | ユーザーのログイン名。 | demo**username |
レスポンス例
{
"createdAt": "2023-03-22T12:44:50.048Z",
"deletedAt": "2023-03-22T12:44:50.048Z",
"email": "test****@example.com",
"id": "99d1****6124",
"lastOrganization": "99d1****6124",
"name": "Example Username",
"nickName": "Example Nickname",
"staffId": "123****",
"sysDeptIds": ["99d1****6124"],
"username": "demo**username"
}エラーコード
詳細については、「エラーコード」をご参照ください。