Get Session Widget

GET

/v1/portal/session/widget

curl --request GET \
  --url 'https://example.com/v1/portal/session/widget?return_to=&tenant_id=' \
  --header 'Host: ' \
  --header 'X-Forwarded-Host: ' \
  --header 'X-Forwarded-Proto: '

Parameters

Query Parameters

return_to

Return To

string

""

tenant_id

Tenant Id

string

""

Header Parameters

X-Forwarded-Proto

X-Forwarded-Proto

string

""

X-Forwarded-Host

X-Forwarded-Host

string

""

Host

Host

string

""

X-FractalOps-Tenant-Id

Any of:

string

string

null

null

x-pomerium-jwt-assertion

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

PortalSessionWidgetOut

object

subject_key

required

Subject Key

string

email

Email

string

""

principal_type

Principal Type

string

default: human

display_name

Display Name

string

""

avatar_url

Avatar Url

string

""

portal_url

Portal Url

string

""

profile_url

Profile Url

string

""

github_linked

Github Linked

boolean

github_username

Github Username

string

""

github_link_required

Github Link Required

boolean

github_link_start_url

Github Link Start Url

string

""

login_url

Login Url

string

""

logout_url

Logout Url

string

""

switch_account_url

Switch Account Url

string

""

Example

{
  "email": "",
  "principal_type": "human",
  "display_name": "",
  "avatar_url": "",
  "portal_url": "",
  "profile_url": "",
  "github_linked": false,
  "github_username": "",
  "github_link_required": false,
  "github_link_start_url": "",
  "login_url": "",
  "logout_url": "",
  "switch_account_url": ""
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}