POpolytomic
Identity

Get Identity

Changed on

Returns information about the authenticated caller and, if applicable, the organization they are scoped to.

Use this endpoint to confirm which kind of credential is being used before calling endpoints with stricter authorization rules.

For user-scoped credentials, the response includes the resolved user and organization details. For non-user keys, the response identifies the key class with the corresponding boolean flags instead of impersonating a user.

This endpoint is especially useful when debugging why a request is being accepted or rejected by endpoints that are limited to particular caller types.

get/api/me

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    none declared

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": {
    "credential": {
      "api_key_profile": {
        "capabilities": {
          "query": {
            "connection_ids": [
              "248df4b7-aa70-47b8-a036-33ac447e668d"
            ]
          },
          "schemas": {
            "connection_ids": [
              "248df4b7-aa70-47b8-a036-33ac447e668d"
            ]
          }
        },
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "kind": "scoped_data",
        "name": "Sales ops agent"
      },
      "harbor": {
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "name": "Sales ops Harbor"
      },
      "method": "api_key",
      "mode": "read_only",
      "oauth_client_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
    },
    "email": "mail@example.com",
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "is_user": true,
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "organization_name": "My Organization",
    "role": "admin"
  }
}

Changes

  • 61c2b96f65baRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added to the / response property allOf list for the response status

  • a4c3b8f8eff7Revision changes
    • info

      added the optional property // to the response with the status