Skip to content

GetAdmin

GET/api/v1/admins/{admin}

Fetch an administrator by name.

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

Set OBLIQUE_API_KEY to your API key.

  • namestringrequired
200Admin

Admins are the set of users responsible for managing Oblique. They have special permissions to own API objects that aren’t explicitly owned by another user, team, or group. They are also responsible for system settings like integrations.

  • namestring

    Assigned by Oblique. The name of the admin API object. 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 API object 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 API object. Populated by the Oblique Terraform provider.

    • repoDirstring

      Optionally, the subdirectory within repo_uri that holds the Terraform configuration for this API object. 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.

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