> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sterndesk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WhoAmI

> WhoAmI returns information about the current authenticated user.



## OpenAPI

````yaml https://edge.test.sterndesk.com/api/openapi.yaml post /rpc/rpc.v1.RootService/WhoAmI
openapi: 3.1.0
info:
  title: Sterndesk API
  version: 1.0.0
  description: >
    HTTP/JSON access to the Sterndesk data available to your account.


    Every Sterndesk operation is a Connect RPC: send `POST <path>` with a JSON
    body and the

    `Connect-Protocol-Version: 1` header. Authenticate with a personal API key

    (Settings → My account → API keys) using `Authorization: Bearer <key>`.


    A key reads everything documented here. The one write operation is uploading
    candidate

    documents, which needs a key carrying the `sterndesk:documents:write`
    permission; permissions

    are chosen when the key is created and are never added to an existing key.
    Every other write

    operation is rejected.


    ## Uploading candidate documents


    An upload is a batch of documents, the same batch a recruiter hands to
    Sterndesk from the

    dashboard. It may hold the documents of one candidate or of several people:
    Sterndesk groups

    them by identity and creates one candidate per person. Sending them takes
    two calls.


    1. `POST /rpc/rpc.v1.OrganizationService/CreateManualUpload` creates the
    upload and returns a
       signed, time-limited instruction: `upload_url`, `params`, `signature` and `expires_at`,
       together with the limits the upload must satisfy.
    2. `POST /assemblies` sends the files to Transloadit, the upload processor,
    as
       `multipart/form-data`, with `params` and `signature` as form fields. Send both verbatim:
       the signature covers those exact bytes, so pretty-printing `params`, reordering its keys,
       or parsing and re-encoding it invalidates the signature. The files go straight to
       Transloadit and never pass through Sterndesk.

    Processing then continues asynchronously, exactly as it does for a dashboard
    upload.

    `POST /rpc/rpc.v1.OrganizationService/ListManualUploads` reports the
    progress of the upload

    created in step 1.
servers:
  - url: https://edge.sterndesk.com
security:
  - apiKey: []
tags:
  - name: rpc.v1.OrganizationService
    description: Organization service RPC for organization method.
  - name: rpc.v1.RootService
    description: RootService provides top-level RPCs.
paths:
  /rpc/rpc.v1.RootService/WhoAmI:
    post:
      tags:
        - rpc.v1.RootService
      summary: WhoAmI
      description: WhoAmI returns information about the current authenticated user.
      operationId: rpc.v1.RootService.WhoAmI
      parameters:
        - name: Connect-Protocol-Version
          in: header
          description: Define the version of the Connect protocol
          required: true
          schema:
            $ref: '#/components/schemas/connect-protocol-version'
          example: 1
        - name: Connect-Timeout-Ms
          in: header
          description: Define the timeout, in ms
          schema:
            $ref: '#/components/schemas/connect-timeout-header'
          example: 1000
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rpc.v1.WhoAmIRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpc.v1.WhoAmIResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connect.error'
components:
  schemas:
    connect-protocol-version:
      type: number
      examples:
        - 1
      title: Connect-Protocol-Version
      description: Define the version of the Connect protocol
      const: 1
    connect-timeout-header:
      type: number
      examples:
        - 1000
      title: Connect-Timeout-Ms
      description: Define the timeout, in ms
    rpc.v1.WhoAmIRequest:
      type: object
      properties:
        echo:
          type: string
          title: echo
          maxLength: 128
          minLength: 1
          description: >-
            a message that will be returned to the user for debugging and
            development
      title: WhoAmIRequest
      additionalProperties: false
      description: request for information about the current authenticated user
    rpc.v1.WhoAmIResponse:
      type: object
      properties:
        id:
          type: string
          title: id
          description: user id of the current authenticated user
        primaryEmail:
          type: string
          title: primary_email
          description: email of the currently logged-in user
        emailVerified:
          type: boolean
          title: email_verified
          description: if an email has been verified
        givenName:
          type:
            - string
            - 'null'
          title: given_name
          description: given name of the currently logged-in user (if any)
        familyName:
          type:
            - string
            - 'null'
          title: family_name
          description: family name of the currently logged-in user (if any)
        backendVersion:
          type: string
          title: backend_version
          description: version of the backend, handy for debugging
        impersonatorEmail:
          type:
            - string
            - 'null'
          title: impersonator_email
          description: >-
            if the current user is impersonating someone, the impersonator's
            email is set here.
        organizationId:
          type:
            - string
            - 'null'
          title: organization_id
          description: id of the organization the user is a member of (if any)
          deprecated: true
        organizationName:
          type:
            - string
            - 'null'
          title: organization_name
          description: name of the organization the user is a member of (if any)
          deprecated: true
        organizationRole:
          type:
            - string
            - 'null'
          title: organization_role
          description: role of the user in the organization (if any)
          deprecated: true
        organizationIsSetupBasic:
          type:
            - boolean
            - 'null'
          title: organization_is_setup_basic
          description: >-
            whether the user's organization has been set up with the basic
            configuration.
          deprecated: true
        organization:
          allOf:
            - $ref: '#/components/schemas/rpc.v1.WhoAmIResponse.Organization'
          title: organization
          description: >-
            info of the active organization. This replaces the separate fields
            above.
        isSetupBasic:
          type: boolean
          title: is_setup_basic
          description: if the user has been setup with basic information
        primaryPhoneE164:
          type:
            - string
            - 'null'
          title: primary_phone_e164
          description: primary phone nr in e164 format
        secondaryPhoneE164:
          type:
            - string
            - 'null'
          title: secondary_phone_e164
          description: secondary phone nr in e164 format
        preferences:
          allOf:
            - $ref: '#/components/schemas/rpc.v1.WhoAmIResponse.Preferences'
          title: preferences
          description: user's preferences
        echo:
          type: string
          title: echo
          description: the input echo returned to the user for debugging and development
      title: WhoAmIResponse
      additionalProperties: false
      description: response with information about the current authenticated user
    connect.error:
      type: object
      properties:
        code:
          type: string
          examples:
            - not_found
          enum:
            - canceled
            - unknown
            - invalid_argument
            - deadline_exceeded
            - not_found
            - already_exists
            - permission_denied
            - resource_exhausted
            - failed_precondition
            - aborted
            - out_of_range
            - unimplemented
            - internal
            - unavailable
            - data_loss
            - unauthenticated
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
        message:
          type: string
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/connect.error_details.Any'
          description: >-
            A list of messages that carry the error details. There is no limit
            on the number of messages.
      title: Connect Error
      additionalProperties: true
      description: >-
        Error type returned by Connect:
        https://connectrpc.com/docs/go/errors/#http-representation
    rpc.v1.WhoAmIResponse.Organization:
      type: object
      properties:
        id:
          type: string
          title: id
          description: id of the organization the user is a member of
        name:
          type: string
          title: name
          description: name of the organization the user is a member of
        role:
          type: string
          title: role
          description: role of the user in the organization
        isSetupBasic:
          type: boolean
          title: is_setup_basic
          description: >-
            whether the organization has been set up with the basic
            configuration
        slug:
          type:
            - string
            - 'null'
          title: slug
          description: slug of the organization (if any).
      title: Organization
      additionalProperties: false
      description: active organization info.
    rpc.v1.WhoAmIResponse.Preferences:
      type: object
      properties:
        notShowGettingStarted:
          type: boolean
          title: not_show_getting_started
          description: show/hide getting started
      title: Preferences
      additionalProperties: false
      description: user's preferences.
    connect.error_details.Any:
      type: object
      properties:
        type:
          type: string
          description: >-
            A URL that acts as a globally unique identifier for the type of the
            serialized message. For example:
            `type.googleapis.com/google.rpc.ErrorInfo`.
        value:
          type: string
          format: binary
          description: >-
            The Protobuf message, serialized as bytes and base64-encoded. The
            specific message type is identified by the `type` field.
        debug:
          type: object
          title: Debug
          additionalProperties: true
          description: >-
            Deserialized error detail payload. The 'type' field indicates the
            schema. This field is for easier debugging and should not be relied
            upon for application logic.
      additionalProperties: true
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message, with an additional debug
        field for ConnectRPC error details.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'Personal API key, sent as `Authorization: Bearer <key>`.'

````