WhoAmI API Endpoint
The following article covers Sigma’s developer WhoAmI endpoint. This endpoint returns the current authorized users id and organizationId.
To find additional information on this or any other organization member, refer to Organization Member API.
Summary of Content
Endpoints
The WhoAmI Object
Attributes
Look up the Authenticated User
Permissions
Parameters
cURL Request
Response
Example
Related Resources
Endpoints
GET /v2/whoami
Returns an object identifying the current authenticated user’s id and organization.
Try it in Swagger
The WhoAmI Object
Attributes
userId string
The authenticated organization member’s unique identifier.
Note: Also referred to as memberId.
organizationId string
The unique identifier of the organization to which the authenticated user belongs.
{
"userId": "7tZszXPRt3LXpIezcD5adESnwy6GGiq",
"organizationId": "yR4de26a-ba1c-4y68-9a2c-72a0744df7pt"
}
Look up the Authenticated User
Returns an object identifying the current authenticated user’s id and organization.
GET /v2/whoAmI
Permissions
Not applicable
Parameters
None
cURL Request
curl --location --request GET 'https://api.sigmacomputing.com/v2/whoami' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
Response
Returns a workbook object.
{
"userId": string,
"organizationId": string
}
Example
Example Request:
curl --location --request GET 'https://api.sigmacomputing.com/v2/whoami' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
Example Response:
{
"userId": "7tZszXPRt3LXpIezcD5adESnwy6GGiq",
"organizationId": "yR4de26a-ba1c-4y68-9a2c-72a0744df7pt"
}
Related Resources
Get Started with Sigma's API
Create an API Token and Client Id
Identify Unique Ids in Sigma