Sessions

Used to interact with the sessions of a client.

Remove client's sessions

Removes all the sessions of the current client without removing the __client cookie

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)

Responses

200

Returns the response for DELETE session object.

401

Request was not successful

404

Request was not successful

delete/v1/client/sessions

Response samples

application/json

{"response": {"object": "client",
"id": "string",
"sign_in": {"object": "sign_in_attempt",
"id": "string",
"status": "abandoned",
"supported_identifiers": ["email_address"
],
"identifier": "string",
"user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true
},
"supported_first_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"first_factor_verification": {"status": "unverified",
"strategy": "password",
"attempts": 0,
"expire_at": 0
},
"supported_second_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"second_factor_verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"created_session_id": "string",
"abandon_at": 0
},
"sign_up": {"object": "sign_up_attempt",
"id": "string",
"status": "abandoned",
"required_fields": ["string"
],
"optional_fields": ["string"
],
"missing_fields": ["string"
],
"unverified_fields": ["string"
],
"verifications": {"email_address": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"phone_number": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"external_account": {"status": "unverified",
"strategy": "oauth_apple",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
}
},
"username": "string",
"email_address": "string",
"phone_number": "string",
"web3_wallet": "string",
"password_enabled": true,
"first_name": "string",
"last_name": "string",
"unsafe_metadata": { },
"public_metadata": { },
"external_id": "string",
"created_session_id": "string",
"created_user_id": "string",
"abandon_at": 0
},
"sessions": [{"id": "string",
"object": "session",
"actor": { },
"status": "active",
"last_active_at": 0,
"expire_at": 0,
"abandon_at": 0,
"user": {"id": "string",
"object": "user",
"external_id": "string",
"primary_email_address_id": "string",
"primary_phone_number_id": "string",
"primary_web3_wallet_id": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"public_metadata": { },
"private_metadata": { },
"unsafe_metadata": { },
"email_addresses": [{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"created_at": 0,
"updated_at": 0
}
],
"phone_numbers": [{"id": "string",
"object": "phone_number",
"phone_number": "string",
"reserved_for_second_factor": true,
"default_second_factor": true,
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"backup_codes": [null
],
"created_at": 0,
"updated_at": 0
}
],
"web3_wallets": [{"id": "string",
"object": "web3_wallet",
"web3_wallet": "string",
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null,
"message": null
},
"created_at": 0,
"updated_at": 0
}
],
"passkeys": [{"id": "string",
"object": "passkey",
"name": "string",
"last_used_at": 0,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null
},
"created_at": 0,
"updated_at": 0
}
],
"organization_memberships": [{"id": "string",
"object": "organization_membership",
"role": "string",
"created_at": 0,
"updated_at": 0,
"organization": {"id": null,
"object": null,
"name": null,
"max_allowed_memberships": null,
"admin_delete_enabled": null,
"slug": null,
"logo_url": null,
"image_url": null,
"has_image": null,
"members_count": null,
"pending_invitations_count": null,
"public_metadata": { },
"created_at": null,
"updated_at": null
},
"public_user_data": {"user_id": null,
"first_name": null,
"last_name": null,
"profile_image_url": null,
"image_url": null,
"has_image": null,
"identifier": null
}
}
],
"password_enabled": true,
"two_factor_enabled": true,
"totp_enabled": true,
"backup_code_enabled": true,
"external_accounts": [{"object": "external_account",
"id": "string",
"provider": "string",
"provider_user_id": "string",
"approved_scopes": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"image_url": "string",
"username": "string",
"public_metadata": { },
"label": "string",
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": { },
"expire_at": null,
"attempts": null
},
"created_at": 0,
"updated_at": 0
}
],
"saml_accounts": [{"id": "string",
"object": "saml_account",
"provider": "string",
"active": true,
"email_address": "string",
"first_name": "string",
"last_name": "string",
"provider_user_id": "string",
"public_metadata": { },
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": null,
"expire_at": null,
"attempts": null
},
"saml_connection": {"id": null,
"name": null,
"domain": null,
"active": null,
"provider": null,
"sync_user_attributes": null,
"allow_subdomains": null,
"allow_idp_initiated": null,
"disable_additional_identifications": null,
"created_at": null,
"updated_at": null
}
}
],
"last_sign_in_at": 0,
"banned": true,
"locked": true,
"lockout_expires_in_seconds": 0,
"verification_attempts_remaining": 0,
"updated_at": 0,
"created_at": 0,
"delete_self_enabled": true,
"create_organization_enabled": true,
"create_organizations_limit": 0,
"last_active_at": 0
},
"public_user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
}
],
"last_active_session_id": "string",
"updated_at": 0,
"created_at": 0
},
"client": { }
}

Get Session

Returns the session with the given id

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)

Request

path Parameters

session_id

required

string

the user session id.

Responses

200

Returns a Session object.

404

Request was not successful

get/v1/client/sessions/{session_id}

Response samples

application/json

{"response": {"id": "string",
"object": "session",
"actor": { },
"status": "active",
"last_active_at": 0,
"expire_at": 0,
"abandon_at": 0,
"user": {"id": "string",
"object": "user",
"external_id": "string",
"primary_email_address_id": "string",
"primary_phone_number_id": "string",
"primary_web3_wallet_id": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"public_metadata": { },
"private_metadata": { },
"unsafe_metadata": { },
"email_addresses": [{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_apple",
"id": "string"
}
],
"created_at": 0,
"updated_at": 0
}
],
"phone_numbers": [{"id": "string",
"object": "phone_number",
"phone_number": "string",
"reserved_for_second_factor": true,
"default_second_factor": true,
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_apple",
"id": "string"
}
],
"backup_codes": ["string"
],
"created_at": 0,
"updated_at": 0
}
],
"web3_wallets": [{"id": "string",
"object": "web3_wallet",
"web3_wallet": "string",
"verification": {"status": "unverified",
"strategy": "web3_metamask_signature",
"attempts": 0,
"expire_at": 0,
"nonce": "string",
"message": "string"
},
"created_at": 0,
"updated_at": 0
}
],
"passkeys": [{"id": "string",
"object": "passkey",
"name": "string",
"last_used_at": 0,
"verification": {"status": "unverified",
"strategy": "passkey",
"attempts": 0,
"expire_at": 0,
"nonce": "string"
},
"created_at": 0,
"updated_at": 0
}
],
"organization_memberships": [{"id": "string",
"object": "organization_membership",
"role": "string",
"created_at": 0,
"updated_at": 0,
"organization": {"id": "string",
"object": "organization",
"name": "string",
"max_allowed_memberships": 0,
"admin_delete_enabled": true,
"slug": "string",
"logo_url": "string",
"image_url": "string",
"has_image": true,
"members_count": 0,
"pending_invitations_count": 0,
"public_metadata": { },
"created_at": 0,
"updated_at": 0
},
"public_user_data": {"user_id": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
}
],
"password_enabled": true,
"two_factor_enabled": true,
"totp_enabled": true,
"backup_code_enabled": true,
"external_accounts": [{"object": "external_account",
"id": "string",
"provider": "string",
"provider_user_id": "string",
"approved_scopes": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"image_url": "string",
"username": "string",
"public_metadata": { },
"label": "string",
"verification": {"status": "unverified",
"strategy": "oauth_google",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
},
"created_at": 0,
"updated_at": 0
}
],
"saml_accounts": [{"id": "string",
"object": "saml_account",
"provider": "string",
"active": true,
"email_address": "string",
"first_name": "string",
"last_name": "string",
"provider_user_id": "string",
"public_metadata": { },
"verification": {"status": "unverified",
"strategy": "saml",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
},
"saml_connection": {"id": "string",
"name": "string",
"domain": "string",
"active": true,
"provider": "string",
"sync_user_attributes": true,
"allow_subdomains": true,
"allow_idp_initiated": true,
"disable_additional_identifications": true,
"created_at": 0,
"updated_at": 0
}
}
],
"last_sign_in_at": 0,
"banned": true,
"locked": true,
"lockout_expires_in_seconds": 0,
"verification_attempts_remaining": 0,
"updated_at": 0,
"created_at": 0,
"delete_self_enabled": true,
"create_organization_enabled": true,
"create_organizations_limit": 0,
"last_active_at": 0
},
"public_user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
},
"client": {"object": "client",
"id": "string",
"sign_in": {"object": "sign_in_attempt",
"id": "string",
"status": "abandoned",
"supported_identifiers": ["email_address"
],
"identifier": "string",
"user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true
},
"supported_first_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"first_factor_verification": {"status": "unverified",
"strategy": "password",
"attempts": 0,
"expire_at": 0
},
"supported_second_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"second_factor_verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"created_session_id": "string",
"abandon_at": 0
},
"sign_up": {"object": "sign_up_attempt",
"id": "string",
"status": "abandoned",
"required_fields": ["string"
],
"optional_fields": ["string"
],
"missing_fields": ["string"
],
"unverified_fields": ["string"
],
"verifications": {"email_address": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"phone_number": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"external_account": {"status": "unverified",
"strategy": "oauth_apple",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
}
},
"username": "string",
"email_address": "string",
"phone_number": "string",
"web3_wallet": "string",
"password_enabled": true,
"first_name": "string",
"last_name": "string",
"unsafe_metadata": { },
"public_metadata": { },
"external_id": "string",
"created_session_id": "string",
"created_user_id": "string",
"abandon_at": 0
},
"sessions": [{"id": "string",
"object": "session",
"actor": { },
"status": "active",
"last_active_at": 0,
"expire_at": 0,
"abandon_at": 0,
"user": {"id": "string",
"object": "user",
"external_id": "string",
"primary_email_address_id": "string",
"primary_phone_number_id": "string",
"primary_web3_wallet_id": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"public_metadata": { },
"private_metadata": { },
"unsafe_metadata": { },
"email_addresses": [{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"created_at": 0,
"updated_at": 0
}
],
"phone_numbers": [{"id": "string",
"object": "phone_number",
"phone_number": "string",
"reserved_for_second_factor": true,
"default_second_factor": true,
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"backup_codes": [null
],
"created_at": 0,
"updated_at": 0
}
],
"web3_wallets": [{"id": "string",
"object": "web3_wallet",
"web3_wallet": "string",
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null,
"message": null
},
"created_at": 0,
"updated_at": 0
}
],
"passkeys": [{"id": "string",
"object": "passkey",
"name": "string",
"last_used_at": 0,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null
},
"created_at": 0,
"updated_at": 0
}
],
"organization_memberships": [{"id": "string",
"object": "organization_membership",
"role": "string",
"created_at": 0,
"updated_at": 0,
"organization": {"id": null,
"object": null,
"name": null,
"max_allowed_memberships": null,
"admin_delete_enabled": null,
"slug": null,
"logo_url": null,
"image_url": null,
"has_image": null,
"members_count": null,
"pending_invitations_count": null,
"public_metadata": { },
"created_at": null,
"updated_at": null
},
"public_user_data": {"user_id": null,
"first_name": null,
"last_name": null,
"profile_image_url": null,
"image_url": null,
"has_image": null,
"identifier": null
}
}
],
"password_enabled": true,
"two_factor_enabled": true,
"totp_enabled": true,
"backup_code_enabled": true,
"external_accounts": [{"object": "external_account",
"id": "string",
"provider": "string",
"provider_user_id": "string",
"approved_scopes": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"image_url": "string",
"username": "string",
"public_metadata": { },
"label": "string",
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": { },
"expire_at": null,
"attempts": null
},
"created_at": 0,
"updated_at": 0
}
],
"saml_accounts": [{"id": "string",
"object": "saml_account",
"provider": "string",
"active": true,
"email_address": "string",
"first_name": "string",
"last_name": "string",
"provider_user_id": "string",
"public_metadata": { },
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": null,
"expire_at": null,
"attempts": null
},
"saml_connection": {"id": null,
"name": null,
"domain": null,
"active": null,
"provider": null,
"sync_user_attributes": null,
"allow_subdomains": null,
"allow_idp_initiated": null,
"disable_additional_identifications": null,
"created_at": null,
"updated_at": null
}
}
],
"last_sign_in_at": 0,
"banned": true,
"locked": true,
"lockout_expires_in_seconds": 0,
"verification_attempts_remaining": 0,
"updated_at": 0,
"created_at": 0,
"delete_self_enabled": true,
"create_organization_enabled": true,
"create_organizations_limit": 0,
"last_active_at": 0
},
"public_user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
}
],
"last_active_session_id": "string",
"updated_at": 0,
"created_at": 0
}
}

Touch session

Specify the active session for the client.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)

Request

path Parameters

session_id

required

string

the user session id.

Request Body schema: application/x-www-form-urlencoded

active_organization_id

string or null

The ID or slug of the organization to activate.

Responses

200

Returns a Session object.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/client/sessions/{session_id}/touch

Request samples

Payload

application/x-www-form-urlencoded

active_organization_id=string

Response samples

application/json

{"response": {"id": "string",
"object": "session",
"actor": { },
"status": "active",
"last_active_at": 0,
"expire_at": 0,
"abandon_at": 0,
"user": {"id": "string",
"object": "user",
"external_id": "string",
"primary_email_address_id": "string",
"primary_phone_number_id": "string",
"primary_web3_wallet_id": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"public_metadata": { },
"private_metadata": { },
"unsafe_metadata": { },
"email_addresses": [{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_apple",
"id": "string"
}
],
"created_at": 0,
"updated_at": 0
}
],
"phone_numbers": [{"id": "string",
"object": "phone_number",
"phone_number": "string",
"reserved_for_second_factor": true,
"default_second_factor": true,
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_apple",
"id": "string"
}
],
"backup_codes": ["string"
],
"created_at": 0,
"updated_at": 0
}
],
"web3_wallets": [{"id": "string",
"object": "web3_wallet",
"web3_wallet": "string",
"verification": {"status": "unverified",
"strategy": "web3_metamask_signature",
"attempts": 0,
"expire_at": 0,
"nonce": "string",
"message": "string"
},
"created_at": 0,
"updated_at": 0
}
],
"passkeys": [{"id": "string",
"object": "passkey",
"name": "string",
"last_used_at": 0,
"verification": {"status": "unverified",
"strategy": "passkey",
"attempts": 0,
"expire_at": 0,
"nonce": "string"
},
"created_at": 0,
"updated_at": 0
}
],
"organization_memberships": [{"id": "string",
"object": "organization_membership",
"role": "string",
"created_at": 0,
"updated_at": 0,
"organization": {"id": "string",
"object": "organization",
"name": "string",
"max_allowed_memberships": 0,
"admin_delete_enabled": true,
"slug": "string",
"logo_url": "string",
"image_url": "string",
"has_image": true,
"members_count": 0,
"pending_invitations_count": 0,
"public_metadata": { },
"created_at": 0,
"updated_at": 0
},
"public_user_data": {"user_id": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
}
],
"password_enabled": true,
"two_factor_enabled": true,
"totp_enabled": true,
"backup_code_enabled": true,
"external_accounts": [{"object": "external_account",
"id": "string",
"provider": "string",
"provider_user_id": "string",
"approved_scopes": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"image_url": "string",
"username": "string",
"public_metadata": { },
"label": "string",
"verification": {"status": "unverified",
"strategy": "oauth_google",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
},
"created_at": 0,
"updated_at": 0
}
],
"saml_accounts": [{"id": "string",
"object": "saml_account",
"provider": "string",
"active": true,
"email_address": "string",
"first_name": "string",
"last_name": "string",
"provider_user_id": "string",
"public_metadata": { },
"verification": {"status": "unverified",
"strategy": "saml",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
},
"saml_connection": {"id": "string",
"name": "string",
"domain": "string",
"active": true,
"provider": "string",
"sync_user_attributes": true,
"allow_subdomains": true,
"allow_idp_initiated": true,
"disable_additional_identifications": true,
"created_at": 0,
"updated_at": 0
}
}
],
"last_sign_in_at": 0,
"banned": true,
"locked": true,
"lockout_expires_in_seconds": 0,
"verification_attempts_remaining": 0,
"updated_at": 0,
"created_at": 0,
"delete_self_enabled": true,
"create_organization_enabled": true,
"create_organizations_limit": 0,
"last_active_at": 0
},
"public_user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
},
"client": {"object": "client",
"id": "string",
"sign_in": {"object": "sign_in_attempt",
"id": "string",
"status": "abandoned",
"supported_identifiers": ["email_address"
],
"identifier": "string",
"user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true
},
"supported_first_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"first_factor_verification": {"status": "unverified",
"strategy": "password",
"attempts": 0,
"expire_at": 0
},
"supported_second_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"second_factor_verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"created_session_id": "string",
"abandon_at": 0
},
"sign_up": {"object": "sign_up_attempt",
"id": "string",
"status": "abandoned",
"required_fields": ["string"
],
"optional_fields": ["string"
],
"missing_fields": ["string"
],
"unverified_fields": ["string"
],
"verifications": {"email_address": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"phone_number": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"external_account": {"status": "unverified",
"strategy": "oauth_apple",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
}
},
"username": "string",
"email_address": "string",
"phone_number": "string",
"web3_wallet": "string",
"password_enabled": true,
"first_name": "string",
"last_name": "string",
"unsafe_metadata": { },
"public_metadata": { },
"external_id": "string",
"created_session_id": "string",
"created_user_id": "string",
"abandon_at": 0
},
"sessions": [{"id": "string",
"object": "session",
"actor": { },
"status": "active",
"last_active_at": 0,
"expire_at": 0,
"abandon_at": 0,
"user": {"id": "string",
"object": "user",
"external_id": "string",
"primary_email_address_id": "string",
"primary_phone_number_id": "string",
"primary_web3_wallet_id": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"public_metadata": { },
"private_metadata": { },
"unsafe_metadata": { },
"email_addresses": [{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"created_at": 0,
"updated_at": 0
}
],
"phone_numbers": [{"id": "string",
"object": "phone_number",
"phone_number": "string",
"reserved_for_second_factor": true,
"default_second_factor": true,
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"backup_codes": [null
],
"created_at": 0,
"updated_at": 0
}
],
"web3_wallets": [{"id": "string",
"object": "web3_wallet",
"web3_wallet": "string",
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null,
"message": null
},
"created_at": 0,
"updated_at": 0
}
],
"passkeys": [{"id": "string",
"object": "passkey",
"name": "string",
"last_used_at": 0,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null
},
"created_at": 0,
"updated_at": 0
}
],
"organization_memberships": [{"id": "string",
"object": "organization_membership",
"role": "string",
"created_at": 0,
"updated_at": 0,
"organization": {"id": null,
"object": null,
"name": null,
"max_allowed_memberships": null,
"admin_delete_enabled": null,
"slug": null,
"logo_url": null,
"image_url": null,
"has_image": null,
"members_count": null,
"pending_invitations_count": null,
"public_metadata": { },
"created_at": null,
"updated_at": null
},
"public_user_data": {"user_id": null,
"first_name": null,
"last_name": null,
"profile_image_url": null,
"image_url": null,
"has_image": null,
"identifier": null
}
}
],
"password_enabled": true,
"two_factor_enabled": true,
"totp_enabled": true,
"backup_code_enabled": true,
"external_accounts": [{"object": "external_account",
"id": "string",
"provider": "string",
"provider_user_id": "string",
"approved_scopes": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"image_url": "string",
"username": "string",
"public_metadata": { },
"label": "string",
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": { },
"expire_at": null,
"attempts": null
},
"created_at": 0,
"updated_at": 0
}
],
"saml_accounts": [{"id": "string",
"object": "saml_account",
"provider": "string",
"active": true,
"email_address": "string",
"first_name": "string",
"last_name": "string",
"provider_user_id": "string",
"public_metadata": { },
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": null,
"expire_at": null,
"attempts": null
},
"saml_connection": {"id": null,
"name": null,
"domain": null,
"active": null,
"provider": null,
"sync_user_attributes": null,
"allow_subdomains": null,
"allow_idp_initiated": null,
"disable_additional_identifications": null,
"created_at": null,
"updated_at": null
}
}
],
"last_sign_in_at": 0,
"banned": true,
"locked": true,
"lockout_expires_in_seconds": 0,
"verification_attempts_remaining": 0,
"updated_at": 0,
"created_at": 0,
"delete_self_enabled": true,
"create_organization_enabled": true,
"create_organizations_limit": 0,
"last_active_at": 0
},
"public_user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
}
],
"last_active_session_id": "string",
"updated_at": 0,
"created_at": 0
}
}

End Session

Marks the given session as ended.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)

Request

path Parameters

session_id

required

string

the user session id.

Responses

200

Returns a Session object.

400

Request was not successful

404

Request was not successful

post/v1/client/sessions/{session_id}/end

Response samples

application/json

{"response": {"id": "string",
"object": "session",
"actor": { },
"status": "active",
"last_active_at": 0,
"expire_at": 0,
"abandon_at": 0,
"user": {"id": "string",
"object": "user",
"external_id": "string",
"primary_email_address_id": "string",
"primary_phone_number_id": "string",
"primary_web3_wallet_id": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"public_metadata": { },
"private_metadata": { },
"unsafe_metadata": { },
"email_addresses": [{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_apple",
"id": "string"
}
],
"created_at": 0,
"updated_at": 0
}
],
"phone_numbers": [{"id": "string",
"object": "phone_number",
"phone_number": "string",
"reserved_for_second_factor": true,
"default_second_factor": true,
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_apple",
"id": "string"
}
],
"backup_codes": ["string"
],
"created_at": 0,
"updated_at": 0
}
],
"web3_wallets": [{"id": "string",
"object": "web3_wallet",
"web3_wallet": "string",
"verification": {"status": "unverified",
"strategy": "web3_metamask_signature",
"attempts": 0,
"expire_at": 0,
"nonce": "string",
"message": "string"
},
"created_at": 0,
"updated_at": 0
}
],
"passkeys": [{"id": "string",
"object": "passkey",
"name": "string",
"last_used_at": 0,
"verification": {"status": "unverified",
"strategy": "passkey",
"attempts": 0,
"expire_at": 0,
"nonce": "string"
},
"created_at": 0,
"updated_at": 0
}
],
"organization_memberships": [{"id": "string",
"object": "organization_membership",
"role": "string",
"created_at": 0,
"updated_at": 0,
"organization": {"id": "string",
"object": "organization",
"name": "string",
"max_allowed_memberships": 0,
"admin_delete_enabled": true,
"slug": "string",
"logo_url": "string",
"image_url": "string",
"has_image": true,
"members_count": 0,
"pending_invitations_count": 0,
"public_metadata": { },
"created_at": 0,
"updated_at": 0
},
"public_user_data": {"user_id": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
}
],
"password_enabled": true,
"two_factor_enabled": true,
"totp_enabled": true,
"backup_code_enabled": true,
"external_accounts": [{"object": "external_account",
"id": "string",
"provider": "string",
"provider_user_id": "string",
"approved_scopes": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"image_url": "string",
"username": "string",
"public_metadata": { },
"label": "string",
"verification": {"status": "unverified",
"strategy": "oauth_google",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
},
"created_at": 0,
"updated_at": 0
}
],
"saml_accounts": [{"id": "string",
"object": "saml_account",
"provider": "string",
"active": true,
"email_address": "string",
"first_name": "string",
"last_name": "string",
"provider_user_id": "string",
"public_metadata": { },
"verification": {"status": "unverified",
"strategy": "saml",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
},
"saml_connection": {"id": "string",
"name": "string",
"domain": "string",
"active": true,
"provider": "string",
"sync_user_attributes": true,
"allow_subdomains": true,
"allow_idp_initiated": true,
"disable_additional_identifications": true,
"created_at": 0,
"updated_at": 0
}
}
],
"last_sign_in_at": 0,
"banned": true,
"locked": true,
"lockout_expires_in_seconds": 0,
"verification_attempts_remaining": 0,
"updated_at": 0,
"created_at": 0,
"delete_self_enabled": true,
"create_organization_enabled": true,
"create_organizations_limit": 0,
"last_active_at": 0
},
"public_user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
},
"client": {"object": "client",
"id": "string",
"sign_in": {"object": "sign_in_attempt",
"id": "string",
"status": "abandoned",
"supported_identifiers": ["email_address"
],
"identifier": "string",
"user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true
},
"supported_first_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"first_factor_verification": {"status": "unverified",
"strategy": "password",
"attempts": 0,
"expire_at": 0
},
"supported_second_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"second_factor_verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"created_session_id": "string",
"abandon_at": 0
},
"sign_up": {"object": "sign_up_attempt",
"id": "string",
"status": "abandoned",
"required_fields": ["string"
],
"optional_fields": ["string"
],
"missing_fields": ["string"
],
"unverified_fields": ["string"
],
"verifications": {"email_address": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"phone_number": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"external_account": {"status": "unverified",
"strategy": "oauth_apple",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
}
},
"username": "string",
"email_address": "string",
"phone_number": "string",
"web3_wallet": "string",
"password_enabled": true,
"first_name": "string",
"last_name": "string",
"unsafe_metadata": { },
"public_metadata": { },
"external_id": "string",
"created_session_id": "string",
"created_user_id": "string",
"abandon_at": 0
},
"sessions": [{"id": "string",
"object": "session",
"actor": { },
"status": "active",
"last_active_at": 0,
"expire_at": 0,
"abandon_at": 0,
"user": {"id": "string",
"object": "user",
"external_id": "string",
"primary_email_address_id": "string",
"primary_phone_number_id": "string",
"primary_web3_wallet_id": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"public_metadata": { },
"private_metadata": { },
"unsafe_metadata": { },
"email_addresses": [{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"created_at": 0,
"updated_at": 0
}
],
"phone_numbers": [{"id": "string",
"object": "phone_number",
"phone_number": "string",
"reserved_for_second_factor": true,
"default_second_factor": true,
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"backup_codes": [null
],
"created_at": 0,
"updated_at": 0
}
],
"web3_wallets": [{"id": "string",
"object": "web3_wallet",
"web3_wallet": "string",
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null,
"message": null
},
"created_at": 0,
"updated_at": 0
}
],
"passkeys": [{"id": "string",
"object": "passkey",
"name": "string",
"last_used_at": 0,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null
},
"created_at": 0,
"updated_at": 0
}
],
"organization_memberships": [{"id": "string",
"object": "organization_membership",
"role": "string",
"created_at": 0,
"updated_at": 0,
"organization": {"id": null,
"object": null,
"name": null,
"max_allowed_memberships": null,
"admin_delete_enabled": null,
"slug": null,
"logo_url": null,
"image_url": null,
"has_image": null,
"members_count": null,
"pending_invitations_count": null,
"public_metadata": { },
"created_at": null,
"updated_at": null
},
"public_user_data": {"user_id": null,
"first_name": null,
"last_name": null,
"profile_image_url": null,
"image_url": null,
"has_image": null,
"identifier": null
}
}
],
"password_enabled": true,
"two_factor_enabled": true,
"totp_enabled": true,
"backup_code_enabled": true,
"external_accounts": [{"object": "external_account",
"id": "string",
"provider": "string",
"provider_user_id": "string",
"approved_scopes": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"image_url": "string",
"username": "string",
"public_metadata": { },
"label": "string",
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": { },
"expire_at": null,
"attempts": null
},
"created_at": 0,
"updated_at": 0
}
],
"saml_accounts": [{"id": "string",
"object": "saml_account",
"provider": "string",
"active": true,
"email_address": "string",
"first_name": "string",
"last_name": "string",
"provider_user_id": "string",
"public_metadata": { },
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": null,
"expire_at": null,
"attempts": null
},
"saml_connection": {"id": null,
"name": null,
"domain": null,
"active": null,
"provider": null,
"sync_user_attributes": null,
"allow_subdomains": null,
"allow_idp_initiated": null,
"disable_additional_identifications": null,
"created_at": null,
"updated_at": null
}
}
],
"last_sign_in_at": 0,
"banned": true,
"locked": true,
"lockout_expires_in_seconds": 0,
"verification_attempts_remaining": 0,
"updated_at": 0,
"created_at": 0,
"delete_self_enabled": true,
"create_organization_enabled": true,
"create_organizations_limit": 0,
"last_active_at": 0
},
"public_user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
}
],
"last_active_session_id": "string",
"updated_at": 0,
"created_at": 0
}
}

Remove Session

Delete the the given session.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)

Request

path Parameters

session_id

required

string

the user session id.

Responses

200

Returns a Session object.

400

Request was not successful

404

Request was not successful

post/v1/client/sessions/{session_id}/remove

Response samples

application/json

{"response": {"id": "string",
"object": "session",
"actor": { },
"status": "active",
"last_active_at": 0,
"expire_at": 0,
"abandon_at": 0,
"user": {"id": "string",
"object": "user",
"external_id": "string",
"primary_email_address_id": "string",
"primary_phone_number_id": "string",
"primary_web3_wallet_id": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"public_metadata": { },
"private_metadata": { },
"unsafe_metadata": { },
"email_addresses": [{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_apple",
"id": "string"
}
],
"created_at": 0,
"updated_at": 0
}
],
"phone_numbers": [{"id": "string",
"object": "phone_number",
"phone_number": "string",
"reserved_for_second_factor": true,
"default_second_factor": true,
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_apple",
"id": "string"
}
],
"backup_codes": ["string"
],
"created_at": 0,
"updated_at": 0
}
],
"web3_wallets": [{"id": "string",
"object": "web3_wallet",
"web3_wallet": "string",
"verification": {"status": "unverified",
"strategy": "web3_metamask_signature",
"attempts": 0,
"expire_at": 0,
"nonce": "string",
"message": "string"
},
"created_at": 0,
"updated_at": 0
}
],
"passkeys": [{"id": "string",
"object": "passkey",
"name": "string",
"last_used_at": 0,
"verification": {"status": "unverified",
"strategy": "passkey",
"attempts": 0,
"expire_at": 0,
"nonce": "string"
},
"created_at": 0,
"updated_at": 0
}
],
"organization_memberships": [{"id": "string",
"object": "organization_membership",
"role": "string",
"created_at": 0,
"updated_at": 0,
"organization": {"id": "string",
"object": "organization",
"name": "string",
"max_allowed_memberships": 0,
"admin_delete_enabled": true,
"slug": "string",
"logo_url": "string",
"image_url": "string",
"has_image": true,
"members_count": 0,
"pending_invitations_count": 0,
"public_metadata": { },
"created_at": 0,
"updated_at": 0
},
"public_user_data": {"user_id": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
}
],
"password_enabled": true,
"two_factor_enabled": true,
"totp_enabled": true,
"backup_code_enabled": true,
"external_accounts": [{"object": "external_account",
"id": "string",
"provider": "string",
"provider_user_id": "string",
"approved_scopes": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"image_url": "string",
"username": "string",
"public_metadata": { },
"label": "string",
"verification": {"status": "unverified",
"strategy": "oauth_google",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
},
"created_at": 0,
"updated_at": 0
}
],
"saml_accounts": [{"id": "string",
"object": "saml_account",
"provider": "string",
"active": true,
"email_address": "string",
"first_name": "string",
"last_name": "string",
"provider_user_id": "string",
"public_metadata": { },
"verification": {"status": "unverified",
"strategy": "saml",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
},
"saml_connection": {"id": "string",
"name": "string",
"domain": "string",
"active": true,
"provider": "string",
"sync_user_attributes": true,
"allow_subdomains": true,
"allow_idp_initiated": true,
"disable_additional_identifications": true,
"created_at": 0,
"updated_at": 0
}
}
],
"last_sign_in_at": 0,
"banned": true,
"locked": true,
"lockout_expires_in_seconds": 0,
"verification_attempts_remaining": 0,
"updated_at": 0,
"created_at": 0,
"delete_self_enabled": true,
"create_organization_enabled": true,
"create_organizations_limit": 0,
"last_active_at": 0
},
"public_user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
},
"client": {"object": "client",
"id": "string",
"sign_in": {"object": "sign_in_attempt",
"id": "string",
"status": "abandoned",
"supported_identifiers": ["email_address"
],
"identifier": "string",
"user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true
},
"supported_first_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"first_factor_verification": {"status": "unverified",
"strategy": "password",
"attempts": 0,
"expire_at": 0
},
"supported_second_factors": [{"strategy": "ticket",
"safe_identifier": "string",
"email_address_id": "string",
"phone_number_id": "string",
"web3_wallet_id": "string",
"passkey_id": "string",
"primary": true,
"default": true
}
],
"second_factor_verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"created_session_id": "string",
"abandon_at": 0
},
"sign_up": {"object": "sign_up_attempt",
"id": "string",
"status": "abandoned",
"required_fields": ["string"
],
"optional_fields": ["string"
],
"missing_fields": ["string"
],
"unverified_fields": ["string"
],
"verifications": {"email_address": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"phone_number": {"next_action": "needs_prepare",
"supported_strategies": ["string"
]
},
"external_account": {"status": "unverified",
"strategy": "oauth_apple",
"external_verification_redirect_url": "string",
"error": {"message": "string",
"long_message": "string",
"code": "string",
"meta": { },
"clerk_trace_id": "string"
},
"expire_at": 0,
"attempts": 0
}
},
"username": "string",
"email_address": "string",
"phone_number": "string",
"web3_wallet": "string",
"password_enabled": true,
"first_name": "string",
"last_name": "string",
"unsafe_metadata": { },
"public_metadata": { },
"external_id": "string",
"created_session_id": "string",
"created_user_id": "string",
"abandon_at": 0
},
"sessions": [{"id": "string",
"object": "session",
"actor": { },
"status": "active",
"last_active_at": 0,
"expire_at": 0,
"abandon_at": 0,
"user": {"id": "string",
"object": "user",
"external_id": "string",
"primary_email_address_id": "string",
"primary_phone_number_id": "string",
"primary_web3_wallet_id": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"public_metadata": { },
"private_metadata": { },
"unsafe_metadata": { },
"email_addresses": [{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"created_at": 0,
"updated_at": 0
}
],
"phone_numbers": [{"id": "string",
"object": "phone_number",
"phone_number": "string",
"reserved_for_second_factor": true,
"default_second_factor": true,
"reserved": true,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null
},
"linked_to": [null
],
"backup_codes": [null
],
"created_at": 0,
"updated_at": 0
}
],
"web3_wallets": [{"id": "string",
"object": "web3_wallet",
"web3_wallet": "string",
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null,
"message": null
},
"created_at": 0,
"updated_at": 0
}
],
"passkeys": [{"id": "string",
"object": "passkey",
"name": "string",
"last_used_at": 0,
"verification": {"status": null,
"strategy": null,
"attempts": null,
"expire_at": null,
"nonce": null
},
"created_at": 0,
"updated_at": 0
}
],
"organization_memberships": [{"id": "string",
"object": "organization_membership",
"role": "string",
"created_at": 0,
"updated_at": 0,
"organization": {"id": null,
"object": null,
"name": null,
"max_allowed_memberships": null,
"admin_delete_enabled": null,
"slug": null,
"logo_url": null,
"image_url": null,
"has_image": null,
"members_count": null,
"pending_invitations_count": null,
"public_metadata": { },
"created_at": null,
"updated_at": null
},
"public_user_data": {"user_id": null,
"first_name": null,
"last_name": null,
"profile_image_url": null,
"image_url": null,
"has_image": null,
"identifier": null
}
}
],
"password_enabled": true,
"two_factor_enabled": true,
"totp_enabled": true,
"backup_code_enabled": true,
"external_accounts": [{"object": "external_account",
"id": "string",
"provider": "string",
"provider_user_id": "string",
"approved_scopes": "string",
"email_address": "string",
"first_name": "string",
"last_name": "string",
"avatar_url": "string",
"image_url": "string",
"username": "string",
"public_metadata": { },
"label": "string",
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": { },
"expire_at": null,
"attempts": null
},
"created_at": 0,
"updated_at": 0
}
],
"saml_accounts": [{"id": "string",
"object": "saml_account",
"provider": "string",
"active": true,
"email_address": "string",
"first_name": "string",
"last_name": "string",
"provider_user_id": "string",
"public_metadata": { },
"verification": {"status": null,
"strategy": null,
"external_verification_redirect_url": null,
"error": null,
"expire_at": null,
"attempts": null
},
"saml_connection": {"id": null,
"name": null,
"domain": null,
"active": null,
"provider": null,
"sync_user_attributes": null,
"allow_subdomains": null,
"allow_idp_initiated": null,
"disable_additional_identifications": null,
"created_at": null,
"updated_at": null
}
}
],
"last_sign_in_at": 0,
"banned": true,
"locked": true,
"lockout_expires_in_seconds": 0,
"verification_attempts_remaining": 0,
"updated_at": 0,
"created_at": 0,
"delete_self_enabled": true,
"create_organization_enabled": true,
"create_organizations_limit": 0,
"last_active_at": 0
},
"public_user_data": {"first_name": "string",
"last_name": "string",
"profile_image_url": "string",
"image_url": "string",
"has_image": true,
"identifier": "string"
}
}
],
"last_active_session_id": "string",
"updated_at": 0,
"created_at": 0
}
}

Create Session Token

Create a session jwt for the authenticated requested user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)

Request

path Parameters

session_id

required

string

The user session id.

Request Body schema: application/x-www-form-urlencoded

organization_id

string or null

The organization id to associate with the token. The user must be a member of the organization. If present but empty, the personal workspace will be set as active. If absent, the previous active organization for the session will be used.

Responses

200

401

Request was not successful

404

Request was not successful

post/v1/client/sessions/{session_id}/tokens

Request samples

Payload

application/x-www-form-urlencoded

organization_id=string

Response samples

application/json

{"jwt": "string"
}

Create Session Token With JWT Template

Create a session jwt for the authenticated requested user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)

Request

path Parameters

session_id required	string the user session id.
template_name required	string the template name

Responses

200

post/v1/client/sessions/{session_id}/tokens/{template_name}

Response samples

application/json

{"jwt": "string"
}

➔ Next to Sign Ins