account.session

GET

/auth/session

const url = 'https://example.com/auth/session';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-openbot-session=<__Host-openbot-session>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/auth/session \
  --cookie __Host-openbot-session=<__Host-openbot-session>

Authorizations

session

Responses

200

Success

application/json

object

userId

required

string

profile

required

object

name

string

email

string

emailVerified

boolean

memberships

required

Array<object>

object

organizationId

required

string

name

required

string

status

required

string

Allowed values: active suspended

roles

required

Array

platformAdmin

required

boolean

expiresAt

required

string

Example

{
  "memberships": [
    {
      "status": "active",
      "roles": [
        "super_administrator"
      ]
    }
  ]
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

MembershipRequired

application/json

object

_tag

required

string

Allowed values: MembershipRequired

Example

{
  "_tag": "MembershipRequired"
}

503

AuthenticationUnavailable | RequestFailed

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "AuthenticationUnavailable"
}