1. Oracle Linux Automation Manager CLI and API Reference Guide 2.1
  2. Tasks
  3. Credential Types

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
  • 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 Oracle Linux Automation Manaer) Search across related fields:

?related__search=findme

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "count":"1",
    "next":null,
    "previous":null,
    "results":[
        {
            "created":"2018-02-01T08:00:00.000000Z",
            "description":"",
            "id":"1",
            "injectors":{
                "env":{
                    "AWX_MY_CLOUD_TOKEN":"{{api_token}}"
                }
            },
            "inputs":{
                "fields":[
                    {
                        "id":"api_token",
                        "label":"API Token",
                        "secret":true,
                        "type":"string"
                    }
                ]
            },
            "kind":"cloud",
            "managed":false,
            "modified":"2018-02-01T08:00:00.000000Z",
            "name":"MyCloud",
            "namespace":null,
            "related":{
                "activity_stream":"/api/v2/credential_types/1/activity_stream/",
                "credentials":"/api/v2/credential_types/1/credentials/"
            },
            "summary_fields":{
                "user_capabilities":{
                    "delete":true,
                    "edit":true
                }
            },
            "type":"credential_type",
            "url":"/api/v2/credential_types/1/"
        }
    ]
}

401 Response

Body
Example Response (application/json)
{
    "detail":"Authentication credentials were not provided. To establish a login session, visit /api/login/."
}
Back to Top