QueryAssist を入手する
リクエスト
GET <REST API URL>/users/queryAssist?query=string&caret=int
パラメーター | 説明 |
---|---|
query | オプション。検索クエリを指定して、返された結果をフィルタリングできます。サポートされている論理演算構文の定義については、照会の構文を参照してください。ユーザーの場合、次のフィールドとタプルがサポートされています。 authLogin : userAzureLogin — 指定された Azure 識別子を持つユーザー authName : userAzureName — Azure によって提供された名のユーザー authName : userSamlName — SAML によって提供された指定された名前のユーザー authLogin : userJBALogin — 指定された JetBrains アカウントのログインを持つユーザー authName : userGoogleName — Google から提供された名前のユーザー googleID : value — 指定された Google 識別子を持つユーザー authLogin : userGithubLogin — 指定された GitHub ログインを持つユーザー authName : value — GitHub によって提供された名のユーザー authLogin : userJiraLogin — 指定された Jira ログインを持つユーザー authName : userJiraName — JetBrains アカウントによって提供された指定された名前のユーザー authLogin : userLdapLogin — 指定された LDAP ユーザー ID を持つユーザー authName : value — LDAP によって提供された指定された名前のユーザー authName : userOpenIDName — OpenID によって提供された指定された名前のユーザー openID : value — 指定された OpenID 識別子を持つユーザー access (project : project , with : role) — 指定されたプロジェクトで割り当てられた指定されたロールを持つユーザーのリストを返します access (project : project , with : permission) — 指定されたプロジェクトで付与された指定された権限を持つユーザーのリストを返します access (project : project) — 指定されたプロジェクトで割り当てられた任意のロールを持つユーザーのリストを返します access (organization : organization , with : role) — 指定された組織で割り当てられた指定されたロールを持つユーザーのリストを返します access (organization : organization , with : permission) — 指定された組織で付与された指定された権限を持つユーザーのリストを返します access (organization : organization) — 指定された組織で割り当てられた任意のロールを持つユーザーのリストを返します access (with : role) — 指定されたロールがどこかに割り当てられているユーザーのリストを返します access (with : permission) — 指定された権限がどこにでも付与されているユーザーのリストを返します after : instant — 指定された瞬間の後に作成されたユーザーのリストを返します authEmail : email — ユーザーの詳細に指定されたメールを含むユーザーのリストを返します authLogin : userCoreLogin — ユーザーの詳細に指定されたログインを持つユーザーのリストを返します authMethod : authModule — 指定された認証モジュールに関連付けられたユーザーの詳細を持つユーザーのセットを返します authModule : authModule — 指定された認証モジュールに関連付けられたユーザーの詳細を持つユーザー authUsername : userCoreLogin — ユーザーの詳細に指定されたユーザー名を持つユーザーのリストを返します banStatus : ban status — 特定のステータスを持つ禁止されたユーザーのセットを返します before : instant — 指定された瞬間より前に作成されたユーザーのリストを返します email : email — 指定されたメールアドレスを持つユーザー group : group — 指定されたグループのメンバーを返します has : lastAccess — 少なくとも 1 回ログインしたユーザーのリストを返します has : ownRole — 直接付与されたロールを持つユーザーのリストを返します has : group — 任意のグループに明示的に追加されたユーザーのリストを返します has : 2FA — 二要素認証を有効にしたユーザーのリストを返します has : authMethod — いくつかのユーザーの詳細を持つユーザー has : email — メールが定義されているユーザー has : verifiedEmail — 確認済みのメールを持つユーザーのリストを返します has : originService — 任意のサービスからインポートされたユーザーの詳細を含むユーザーのリストを返します has : login — ログインしているユーザーのリストを返します has : sshPublicKey — SSH 公開鍵を持つユーザーのリストを返します has : approved resource — 承認されたリソースを持つユーザーのリストを返します has : refresh token — リフレッシュトークンを持つユーザーのリストを返します has : permanent token — 永続的なトークンが作成されたユーザーのリストを返します has : accepted end-user agreement — エンドユーザー契約の現在のバージョンを受け入れたユーザーのリストを返します id : value — 指定された ID を持つユーザー in : group — 指定されたグループまたはそのサブグループのメンバーであるユーザーのリストを返します in : team — 指定されたプロジェクトチームのメンバーであるユーザーのリストを返します is : guest — ゲストユーザーを返します is : banned — 禁止されているユーザーのリストを返します is : supporting2FA — 二要素認証を使用できる資格情報を持つユーザーのリストを返します lastAccess (after : instant) — 指定された瞬間の後に Hub にログインしたユーザーのリストを返します lastAccess (before : instant) — 指定された瞬間より前に Hub にログインしたユーザーのリストを返します lastAccess (after : instant , before : instant) — 指定された期間中に Hub にログインしたユーザーのリストを返します login : userLogin — 指定されたログインを持つユーザーのリストを返します name : userName — 指定されたフルネームのユーザーのリストを返します nameStartsWith : value — 指定された接頭辞で始まる名前またはログインを持つユーザーのリストを返します originService : service — 指定されたサービスからインポートされたユーザーの詳細を含むユーザーのリストを返します ownRole : role — プロジェクトまたは組織で直接付与された、指定されたロールを持つユーザーのリストを返します sshPublicKey : value — 指定された SSH 公開鍵を持つユーザーを返します team : team — 指定されたチームのメンバーのリストを返します type : user type — 指定されたユーザータイプのユーザーのリストを返します username : userUsername — 指定されたユーザー名を持つユーザーのリストを返します vcsUserName : vcsUserName — VCS で指定されたユーザー名を持つユーザーのリストを返します |
caret | 型 int のクエリパラメーター。 |
レスポンス
レスポンスコード | 意味 |
---|---|
200 OK | リクエストが成功しました。 |
400 不正な要求 | リクエストパラメーターの少なくとも 1 つが無効です。例: 渡された JSON オブジェクトの必須フィールドがありません。詳細については、応答のエラーメッセージを確認してください。 |
403 禁止します | 要求元は、要求されたリソースにアクセスできません。 |
404 お探しのページが見つかりませんでした | 要求されたリソースが見つかりませんでした。 |
500 内部サーバーエラー | サーバーエラーのため、リクエストの処理に失敗しました。詳細については、応答のエラーメッセージを確認してください。 |
レスポンスボディ
{
"query": string,
"caret": int,
"styleRanges": [queryStyleRange, ...],
"suggestions": [querySuggestItem, ...]
}