Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

ユーザーのリスト

get

/api/v2/users/

このリソースに対してGETリクエストを行って、ユーザーのリストを取得します。

結果のデータ構造には次が含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

countフィールドは、対象となる問合せで見つかったユーザーの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上のユーザー・レコードが含まれます。

それぞれのユーザー・データ構造には次のフィールドが含まれます。

id: このユーザーのデータベースID。(整数)
type: このユーザーのデータ型。(選択)
url: このユーザーのURL。(文字列)
related: 関連リソースのURLを含むデータ構造。(オブジェクト)
summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
created: このユーザーが作成されたときのタイムスタンプ。(日時)
modified: このユーザーが最後に変更されたタイムスタンプ。(日時)
username: 必須。150文字以下。文字、数字および@/./+/-/_のみ。(文字列)
first_name: (文字列)
last_name: (文字列)
email: (文字列)
is_superuser: 明示的に割り当てることなく、このユーザーがすべての権限を持つことを示します。(ブール)
is_system_auditor: (ブール)
ldap_dn: (文字列)
last_login: (日時)
external_account: アカウントが外部サービスによって管理されている場合に設定します(フィールド)

ユーザーが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。

?order_by=username

フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。

?order_by=-username

フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。

?order_by=username,some_other_field

リクエストごとに返される結果の数を変更するには、page_size問合せ文字列パラメータを使用します。特定のページの結果を取得するには、page問合せ文字列パラメータを使用します。

?page_size=100&page=2

結果で返されるpreviousリンクおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。

モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search問合せ文字列パラメータを使用します。

?search=findme

( 「Oracle Linux Automation Manaerに追加」)関連フィールド全体を検索します:

?related__search=findme

サポートされているメディア・タイプ

問合せパラメータ

先頭に戻る

サポートされているメディア・タイプ

レスポンスの例(application/json)

{
    "count":0,
    "next":null,
    "previous":null,
    "results":[
    ]
}

先頭に戻る