Get Identity | Polytomic Docs

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.

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.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Response

errorany

resultany

Errors

401

Unauthorized Error

500

Internal Server Error

1	curl https://app.polytomic.com/api/me \
2	-H "X-Polytomic-Version: X-Polytomic-Version" \
3	-H "Content-Type: application/json" \
4	-u "<username>:<password>"

1	{
2	"result": {
3	"user": {
4	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
5	"email": "jane.doe@example.com",
6	"name": "Jane Doe",
7	"roles": [
8	"admin",
9	"editor"
10	],
11	"organization": {
12	"id": "org-9876543210",
13	"name": "Acme Corporation",
14	"plan": "enterprise"
15	}
16	},
17	"keyClass": {
18	"isUserScoped": true,
19	"isDeploymentKey": false,
20	"isApiKey": true
21	}
22	}
23	}

Authentication

Headers

Response

Errors