ユーザーのすべてのユーザー詳細を取得する
リクエスト
GET <REST API URL>/users/{user id}/userdetails?fields=string&$skip=int&$top=int&query=stringパラメーター | 説明 |
|---|---|
fields | オプション。各 UserDetail のフィールドの指定されたサブセットのみを返します。フィールド構文を使用してサブセットを定義します。 |
$skip | オプション。最初の詳細を返す前にスキップする UserDetail の数を設定できます。 |
$top | オプション。返す UserDetails の最大数を設定できます。 |
query | オプション。検索クエリを指定して、返された結果をフィルタリングできます。サポートされている論理演算構文の定義については、照会の構文を参照してください。UserDetails の場合、次のフィールドとタプルがサポートされています。 authLogin : userAzureLogin — 指定された Azure 識別子を持つユーザーの詳細 authName : userAzureName — Azure によって提供された名のユーザー authName : userSamlName — SAML によって提供された名前のユーザー詳細 authLogin : value — 指定された JetBrains アカウントログインのユーザー詳細 authLogin : userGithubLogin — 指定された GitHub ログインでのユーザーの詳細 fullName : value — GitHub で指定された名前のユーザーの詳細 authLogin : userJiraLogin — Jira にログインしたユーザーの詳細 authName : userJiraName — Jira で指定された名前のユーザー詳細 authLogin : userLdapLogin — 指定された LDAP ユーザー ID を持つユーザーの詳細 authName : value — LDAP で指定された名前のユーザーの詳細 authName : userOpenIDName — OpenID に指定された名前のユーザー詳細 has : avatar — アバターがいます openID : value — 指定された OpenID 識別子を持つユーザーの詳細 authLogin : value — 指定された Hub ログインでのユーザーの詳細 authMethod : authModule — 特定の認証モジュールに関連付けられているユーザーの詳細 email : email — 指定されたメールのユーザー詳細 has : email — メールによるユーザーの詳細 has : originService — 一部のサービスからインポートされたユーザーの詳細 has : authLogin — ログイン時の詳細 id : value — 指定された ID のユーザー詳細 originService : service — 特定のサービスからインポートされたユーザーの詳細 type : authModuleType — 指定されたタイプの認証モジュールのユーザー詳細 user : user — 特定のユーザーのユーザー詳細 |
レスポンス
レスポンスコード | 意味 |
|---|---|
200 OK | リクエストが成功しました。 |
400 不正な要求 | リクエストパラメーターの少なくとも 1 つが無効です。例: 渡された JSON オブジェクトの必須フィールドがありません。詳細については、応答のエラーメッセージを確認してください。 |
403 禁止します | 要求元は、要求されたリソースにアクセスできません。 |
404 お探しのページが見つかりませんでした | 要求されたリソースが見つかりませんでした。 |
500 内部サーバーエラー | サーバーエラーのため、リクエストの処理に失敗しました。詳細については、応答のエラーメッセージを確認してください。 |
レスポンスボディ
{
"skip": int,
"top": int,
"total": int,
"userdetails": [details, ...]
}
