Lists resources of the same kind within an organization account.

v1.0.0

Kinds of resources include: policy, user, host, group, layer, or variable

If a limit is given, returns no more than that number of results. Providing an offset skips a number of resources before returning the rest. In addition, providing an offset will give limit a default value of 10 if none other is provided. These two parameters can be combined to page through results.

If the parameter count is true, returns only the number of items in the list.

Text search

If the search parameter is provided, narrows results to those pertaining to the search query. Search works across resource IDs and the values of annotations. It weighs results so that those with matching id or a matching value of an annotation called name appear first, then those with another matching annotation value, and finally those with a matching kind.

Input

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string",
      "description": "Conjur account name"
    },
    "acting_as": {
      "type": "string",
      "description": "##### Kinds of roles:\n\n- User: one unique wonderful human\n- Host: a single logical machine (in the broad sense, not just physical)\n- Layer: a collection of hosts that have the same privileges\n- Group: a collection of users and groups that have the same privileges\n- Policy: a role which owns of a set of related object\n\nAny identifier included in the URL must be URL-encoded to be recognized by the Conjur API.\n\n##### Resource Identifiers:\n\n- `myapp-01` -> `myapp-01` (unchanged)\n- `alice@devops` -> `alice%40devops`\n- `prod/aws/db-password` -> `prod%2Faws%2Fdb-password`\n- `research+development` -> `research%2Bdevelopment`\n- `sales&marketing` -> `sales%26marketing`\n"
    },
    "count": {
      "type": "boolean",
      "description": "Return only the count of results"
    },
    "kind": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "description": "Return no more than this number of results"
    },
    "offset": {
      "type": "integer",
      "description": "Skips this many items before returning the rest"
    },
    "role": {
      "type": "string",
      "description": "##### Kinds of roles:\n\n- User: one unique wonderful human\n- Host: a single logical machine (in the broad sense, not just physical)\n- Layer: a collection of hosts that have the same privileges\n- Group: a collection of users and groups that have the same privileges\n- Policy: a role which owns of a set of related object\n\nAny identifier included in the URL must be URL-encoded to be recognized by the Conjur API.\n\n##### Resource Identifiers:\n\n- `myapp-01` -> `myapp-01` (unchanged)\n- `alice@devops` -> `alice%40devops`\n- `prod/aws/db-password` -> `prod%2Faws%2Fdb-password`\n- `research+development` -> `research%2Bdevelopment`\n- `sales&marketing` -> `sales%26marketing`\n"
    },
    "search": {
      "type": "string",
      "description": "Only returns results that contain this string value"
    }
  },
  "required": [
    "account",
    "kind"
  ],
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "annotations": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "created_at": {
        "type": "string"
      },
      "id": {
        "type": "string"
      },
      "owner": {
        "type": "string"
      },
      "permissions": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "policy": {
              "type": "string"
            },
            "privilege": {
              "type": "string"
            },
            "role": {
              "type": "string"
            }
          }
        }
      },
      "policy": {
        "type": "string"
      },
      "policy_versions": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "client_ip": {
              "type": "string"
            },
            "created_at": {
              "type": "string"
            },
            "finished_at": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "policy_sha256": {
              "type": "string"
            },
            "policy_text": {
              "type": "string"
            },
            "role": {
              "type": "string"
            },
            "version": {
              "type": "number"
            }
          }
        }
      },
      "restricted_to": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "secrets": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "expires_at": {
              "type": "string"
            },
            "version": {
              "type": "number"
            }
          }
        }
      }
    }
  }
}