Jump to

• Request
• Response

List Credential Types

get

/api/v2/credential_types/

Make a GET request to this resource to retrieve the list of credential types.

The resulting data structure contains:

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

The count field indicates the total number of credential types found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more credential type records.

Results

Each credential type data structure includes the following fields:

• id: Database ID for this credential type. (integer)
• type: Data type for this credential type. (choice)
• url: URL for this credential type. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this credential type was created. (datetime)
• modified: Timestamp when this credential type was last modified. (datetime)
• name: Name of this credential type. (string)
• description: Optional description of this credential type. (string)
• kind: (choice)
  • ssh: Machine
  • vault: Vault
  • net: Network
  • scm: Source Control
  • cloud: Cloud
  • registry: Container Registry
  • token: Personal Access Token
  • insights: Insights
  • external: External
  • kubernetes: Kubernetes
  • galaxy: Galaxy/Automation Hub
  • cryptography: Cryptography
• namespace: (string)
• managed: (boolean)
• inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
• injectors: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)

Sorting

To specify that credential types are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Ansible Tower 3.1.0) Search across related fields:

?related__search=findme

Request

Supported Media Types

• application/json

Query Parameters

• page: integer
  A page number within the paginated result set.
• page_size: integer
  Number of results to return per page.
• search: string
  A search term.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• 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"
}

Nested Schema : results

Type: array

Show Source

• Array of: object CredentialType

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

Nested Schema : CredentialType

Type: object

Show Source

• created: string
  Title: Created

  Read Only: true
• description: string
  Title: Description
• id: integer
  Title: ID

  Read Only: true
• injectors: object Injectors
  Title: Injectors

  Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.
• inputs: object Inputs
  Title: Inputs

  Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
• kind(required): string
  Title: Kind

  Allowed Values: [ "ssh", "vault", "net", "scm", "cloud", "registry", "token", "insights", "external", "kubernetes", "galaxy", "cryptography" ]
• managed: string
  Title: Managed

  Read Only: true
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• namespace: string
  Title: Namespace

  Read Only: true

  Minimum Length: 1
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: 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"
}

Nested Schema : Injectors

Type: object

Title: Injectors

Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.

Nested Schema : Inputs

Type: object

Title: Inputs

Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.

Back to Top