Skip to content

SessionContext

How the caller signed in.

Fields

  • mfaAuthenticatedbooleanrequired
  • clientIdoptionalstring | null

    The OAuth client, for oauth.

  • credentialoptionalstring | null

    session, apiKey, oauth, ssoOauth or federation (a directory user acting as a bot in the console).

  • directoryIdoptionalstring | null

    The SSO directory, for ssoOauth, federation and a temporary API key (apiKey with an SsoUser sourceIdentity). Absent otherwise, and for an OIDC API key.

  • resourceoptionalstring | null

    The bound resource URL, for ssoOauth. Absent for existing credentials.

  • sessionIssuedAtoptionalstring | null
  • sourceIdentityoptionalSourceIdentityornull
    2 variants

    One of the following:

    • 3 properties
      • principalIdstringrequired

        The directory user's ID, or for OidcSubject the OIDC provider's, for ComputeInstance the instance's, for KubernetesPod and KubernetesCluster the cluster's, for BuildTask the build task's, for Sandbox the sandbox's, for DeployStep the deployment step's.

        format: uuid
      • typestringrequired

        SsoUser, OidcSubject, ComputeInstance, KubernetesPod, KubernetesCluster, BuildTask, Sandbox or DeployStep.

      • userNamestringrequired

        The directory user's username, or for OidcSubject the token's sub, for ComputeInstance the instance's name, for KubernetesPod namespace/service-account, for KubernetesCluster the cluster's name, for BuildTask pipeline-id/task-name, for Sandbox the sandbox's name, for DeployStep deployment-id/step-id; 1 to 256 characters.

    • null
  • ssoProviderIdoptionalstring | null
Navigation

Type to search…

↑↓ navigate↵ selectEsc close