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

資格証明タイプのリスト

get

/api/v2/credential_types/

このリソースに対して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: この資格証明タイプが最後に変更されたときのタイムスタンプ。(日時)
name: この資格証明タイプの名前。(文字列)
description: この資格証明タイプのオプションの説明。(文字列)
kind: (選択)
- ssh: マシン
- vault: ボールト
- net: ネットワーク
- scm: ソース・コントロール
- cloud: クラウド
- registry: コンテナ・レジストリ
- token: 個人アクセス・トークン
- insights: インサイト
- external: 外部
- kubernetes: Kubernetes
- galaxy: Galaxy/Automation Hub
- cryptography: 暗号
namespace: (文字列)
managed: (boolean)
inputs: JSONまたはYAML構文を使用して入力を入力します。構文例は、ドキュメンテーションを参照してください。(json)
injectors: JSONまたはYAML構文を使用してインジェクタを入力します。構文例は、ドキュメンテーションを参照してください。(json)

ソート

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

?order_by=name

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

?order_by=-name

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

?order_by=name,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/CredentialType"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

Array of: object CredentialType

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

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

型: object

ソースを表示

created: string

タイトル: Created

読取り専用: true
description: string

タイトル: Description
id: integer

タイトル: ID

読取り専用: true
injectors: object Injectors

タイトル: Injectors

JSONまたはYAML構文を使用してインジェクタを入力します。構文の例は、ドキュメントを参照してください。
inputs: object Inputs

タイトル: Inputs

JSONまたはYAML構文を使用して入力を入力します。構文の例は、ドキュメントを参照してください。
kind(required): string

タイトル: Kind

指定できる値: [ "ssh", "vault", "net", "scm", "cloud", "registry", "token", "insights", "external", "kubernetes", "galaxy", "cryptography" ]
managed: string

タイトル: Managed

読取り専用: true
modified: string

タイトル: Modified

読取り専用: true
name(required): string

タイトル: Name

最小長: 1

最大長: 512
namespace: string

タイトル: Namespace

読取り専用: true

最小長: 1
related: string

タイトル: Related

読取り専用: true
summary_fields: string

タイトル: Summary fields

読取り専用: true
type: string

タイトル: Type

読取り専用: true
url: string

タイトル: Url

読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "injectors":{
            "description":"Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Injectors",
            "type":"object"
        },
        "inputs":{
            "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Inputs",
            "type":"object"
        },
        "kind":{
            "enum":[
                "ssh",
                "vault",
                "net",
                "scm",
                "cloud",
                "registry",
                "token",
                "insights",
                "external",
                "kubernetes",
                "galaxy",
                "cryptography"
            ],
            "title":"Kind",
            "type":"string",
            "x-nullable":true
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "namespace":{
            "minLength":"1",
            "readOnly":true,
            "title":"Namespace",
            "type":"string",
            "x-nullable":true
        },
        "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"
        }
    },
    "required":[
        "name",
        "kind"
    ],
    "type":"object"
}

ネストされたスキーマ : インジェクタ

型: object

タイトル: Injectors

JSONまたはYAML構文を使用してインジェクタを入力します。構文の例は、ドキュメントを参照してください。

ネストされたスキーマ : 入力

型: object

タイトル: Inputs

JSONまたはYAML構文を使用して入力を入力します。構文の例は、ドキュメントを参照してください。

先頭に戻る