Create a session

Here you will learn, how to create a session.
At the end, you get a token, which is required for further updates of this session.

First, we have to initialize the class.

use ZitadelPhpClient\Session\Create;

$create_session = new Create($settings);

Set the user identifier

At the beginning, we have to set a user identifier. This can be the user id or the login name. You can't use both. This will produce an error.

$create_session->setUserId("123456789");

$create_session->setLoginName("doe@your-zitadel-instance.com");

You can send several checks Zitadel, such as the password or 2-factor codes. The session is only created if all checks are successful.

$create_session->setPassword("S3cr3t!");

You get the required values from the IDP-class.

$create_session->setIdpIntentId("123456789");
$create_session->setIdpIntentToken("ABCDEFGHIJKLMNOP");

$create_session->setTOTPCode("123456");

$create_session->setSmsCode("123456");

$create_session->setEmailCode("123456");

You can set challenges, e.g. an OTP-SMS-Code. If you set a challenge, you can get the code after performing the request.

$create_session->returnSmsCode();

After performing the request, you can get the code with:

$create_session->getSmsCode();

$create_session->returnEmailCode();

After performing the request, you can get the code with:

$create_session->getEmailCode();

You can set a lifetime in seconds after which the session will be automatically invalidated.

$create_session->setLifetime(3600);

try {
    $create_session->create();
} catch (Exception $e) {
    echo $e->getMessage();
}

After performing this request, you can get the Session-ID and the Session-Token.

$create_session->getSessionId();

$create_session->getSessionToken();

Last modified: 08 April 2024