機械翻訳について

移動先

• リクエスト
• レスポンス

ユーザーのリスト

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: (ブール)
• password: パスワードの変更に使用するフィールド。(文字列)
• 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

(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。

?related__search=findme

リクエスト

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

• application/json

問合せパラメータ

• page: integer
  ページ区切りが設定された結果セット内のページ番号。
• page_size: integer
  ページごとに返す結果の数。
• search: string
  検索条件。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/User"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

ネストされたスキーマ: results

型: array

ソースを表示

• Array of: object User

{
    "items":{
        "$ref":"#/definitions/User"
    },
    "type":"array"
}

ネストされたスキーマ: User

型: object

ソースを表示

• created: string
  タイトル: Created

  読取り専用: true
• email: string
  タイトル: Email address

  最大長: 254
• external_account: string
  タイトル: External account

  読取り専用: true

  アカウントが外部サービスによって管理されるかどうかを設定
• first_name: string
  タイトル: First name

  最大長: 150
• id: integer
  タイトル: ID

  読取り専用: true
• is_superuser: boolean
  タイトル: Superuser status

  明示的に割り当てることなく、このユーザーにすべての権限があることを指定します。
• is_system_auditor: boolean
  タイトル: Is system auditor
• last_login: string(date-time)
  タイトル: Last login

  読取り専用: true
• last_name: string
  タイトル: Last name

  最大長: 150
• ldap_dn: string
  タイトル: Ldap dn

  読取り専用: true

  最小長: 1
• modified: string
  タイトル: Modified

  読取り専用: true
• password: string
  タイトル: Password

  最小長: 1

  パスワードの変更に使用するフィールド。
• related: string
  タイトル: Related

  読取り専用: true
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• type: string
  タイトル: Type

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true
• username(required): string
  タイトル: Username

  最小長: 1

  最大長: 150

  パターン: ^[\w.@+-]+$

  必須。150文字以下。 文字、数字および@/./+/-/_のみ。

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "email":{
            "maxLength":"254",
            "title":"Email address",
            "type":"string",
            "x-nullable":true
        },
        "external_account":{
            "description":"Set if the account is managed by an external service",
            "readOnly":true,
            "title":"External account",
            "type":"string"
        },
        "first_name":{
            "maxLength":"150",
            "title":"First name",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "is_superuser":{
            "description":"Designates that this user has all permissions without explicitly assigning them.",
            "title":"Superuser status",
            "type":"boolean",
            "x-nullable":true
        },
        "is_system_auditor":{
            "title":"Is system auditor",
            "type":"boolean"
        },
        "last_login":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last login",
            "type":"string",
            "x-nullable":true
        },
        "last_name":{
            "maxLength":"150",
            "title":"Last name",
            "type":"string",
            "x-nullable":true
        },
        "ldap_dn":{
            "minLength":"1",
            "readOnly":true,
            "title":"Ldap dn",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "password":{
            "description":"Field used to change the password.",
            "minLength":"1",
            "title":"Password",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "username":{
            "description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength":"150",
            "minLength":"1",
            "pattern":"^[\\w.@+-]+$",
            "title":"Username",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "username"
    ],
    "type":"object"
}

先頭に戻る