> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # Get current user GET https://api.sigmacomputing.com/v2/whoami Get the identity and authentication status of the current user. ### Usage notes Call this endpoint after authenticating to retrieve user details. It does not require any parameters other than the user's valid session or authentication token included in the request headers. ### Usage scenarios - **Session validation:** Quickly confirm user authentication and retrieve session-specific details at the start of a new session. - **User configuration:** Retrieve settings or configurations specific to the user, allowing for a customized application experience based on user roles and permissions. ### Best practices - Call this endpoint at the beginning of each session to ensure that the user's credentials are still valid and have not been revoked. - Use the information provided by this endpoint to tailor the user interface and functionality accessible to the user, enhancing security and user experience. Reference: https://help.sigmacomputing.com/reference/whoami ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: sigma-rest-api version: 1.0.0 paths: /v2/whoami: get: operationId: whoami summary: Get current user description: |- Get the identity and authentication status of the current user. ### Usage notes Call this endpoint after authenticating to retrieve user details. It does not require any parameters other than the user's valid session or authentication token included in the request headers. ### Usage scenarios - **Session validation:** Quickly confirm user authentication and retrieve session-specific details at the start of a new session. - **User configuration:** Retrieve settings or configurations specific to the user, allowing for a customized application experience based on user roles and permissions. ### Best practices - Call this endpoint at the beginning of each session to ensure that the user's credentials are still valid and have not been revoked. - Use the information provided by this endpoint to tailor the user interface and functionality accessible to the user, enhancing security and user experience. tags: - '' parameters: - name: Authorization in: header description: OAuth authentication required: true schema: type: string responses: '200': description: The response body. content: application/json: schema: $ref: '#/components/schemas/whoami_Response_200' servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations components: schemas: whoami_Response_200: type: object properties: userId: type: string organizationId: type: string required: - userId - organizationId title: whoami_Response_200 securitySchemes: OAuth: type: http scheme: bearer description: OAuth 2.0 authentication ``` ## Examples **Response** ```json { "userId": "string", "organizationId": "string" } ``` **SDK Code** ```python import requests url = "https://api.sigmacomputing.com/v2/whoami" headers = {"Authorization": "."} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sigmacomputing.com/v2/whoami'; const options = {method: 'GET', headers: {Authorization: '.'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.sigmacomputing.com/v2/whoami" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", ".") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sigmacomputing.com/v2/whoami") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.sigmacomputing.com/v2/whoami") .header("Authorization", ".") .asString(); ``` ```php request('GET', 'https://api.sigmacomputing.com/v2/whoami', [ 'headers' => [ 'Authorization' => '.', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sigmacomputing.com/v2/whoami"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "."] let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/whoami")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```