Sign out

POST

/v1/id/sign-out

const url = 'https://your-tenant-host/v1/id/sign-out';
const options = {
  method: 'POST',
  headers: {
    cookie: 'ek.session_token=<ek.session_token>',
    'x-edgekit-site-id': 'site_example'
  }
};

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

curl --request POST \
  --url https://your-tenant-host/v1/id/sign-out \
  --header 'x-edgekit-site-id: site_example' \
  --cookie ek.session_token=<ek.session_token>

Revokes the server record and clears the cookies. Answers 200 even when no session was presented, so a retry is safe. In dual it also returns the identity provider logout URL, because the two sessions are independent and back-channel logout is unavailable for every v1 mechanism.

Authorizations

UserSession

Parameters

Header Parameters

x-edgekit-site-id

required

The site this request is for, within this tenant. Every official EdgeKit SDK sets it from the client you configured; set it yourself only when calling this API directly.

string

>= 1 characters <= 128 characters

Example

site_example

The site this request is for, within this tenant. Every official EdgeKit SDK sets it from the client you configured; set it yourself only when calling this API directly.

Responses

200

The session is gone.

application/json

object

success

required

boolean

logoutUrl

required

string | null

Example

{
  "success": true,
  "logoutUrl": "https://id.example.com/logout"
}

400

Invalid request.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

403

Not allowed.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

404

Resource not found.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

422

Request validation failed.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

500

Unexpected error.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}