EDedgeimpulse
Organizations

Get info about current API key

Only available when authenticating with an organization API key. Returns the current role and organization ID that you're authenticated with.

get/api/organizations/{organizationId}/api-key-info

Request

Path parameters

organizationIdinteger required

Organization ID

Response

OK

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

apiKeyIdinteger required
organizationIdinteger required
role'admin' | 'member' required
expiresstring date-time

The expiration date of the API key. Only present when the key has a TTL set.

anonymousUserIdstring

Only present when the API key was created for an organization extension. An anonymized, but stable ID for the user that granted the extension access. The ID is unique per extension, and does not reveal any information about the user. Extensions can use this to keep sessions or per-user state. This matches the anonymousUserId query parameter that is passed to the extension.

Changes

No recorded changes to this operation across all 1 revision of this API.