Skip to content

ListAdmins

GET/api/v1/admins

List all system-wide administrators.

Example request

curl \
-H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
"https://us.oblique.security/api/v1/admins"

Set OBLIQUE_API_KEY to your API key.

Query parameters

  • pageSizeinteger (int32)
  • pageTokenstring

Response

200ListAdminsResponse
  • adminsAdmin[]
    • namestring

      Assigned by Oblique. The name of the admin resource. This is an arbitrary string and does not have to match the user’s name.

    • managementManagement

      How this admin is managed. Set automatically by the server based on the calling client. Omitted from responses when the admin is manually managed (the default).

      • managerstring
        Allowed values: TERRAFORM

        How the resource is managed. Set automatically by the server based on the caller: Terraform clients produce TERRAFORM; for all other clients the management field is left unset on the response.

      • repoUristring

        URI of the VCS repository that holds the Terraform configuration for this resource. Populated by the Oblique Terraform provider.

      • repoDirstring

        Optionally, the subdirectory within repo_uri that holds the Terraform configuration for this resource. Populated by the Oblique Terraform provider.

    • userstringrequired

      The user that has been granted admin privileges.

      Format: users/{user}

    • createTimestring (date-time)read-only

      The time the admin was created.

    • updateTimestring (date-time)read-only

      The time the admin was last updated.

  • nextPageTokenstring

Errors

StatusMeaning
400Malformed request
401Missing or invalid API key
403Not allowed for this API key
404Not found
429Too many requests
500Internal server error