Class SessionsClient

Index

Constructors

constructor

new SessionsClient(options: BaseClientOptions): SessionsClient
Parameters
- options: BaseClientOptions
Returns SessionsClient

Methods

get

get(
id: string,
requestOptions?: SessionsClient.RequestOptions,
): HttpResponsePromise<GetSessionResponseContent>
Retrieve session information.
Parameters
- id: string
  ID of session to retrieve
- OptionalrequestOptions: SessionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetSessionResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.sessions.get("id")
```

delete

delete(
id: string,
requestOptions?: SessionsClient.RequestOptions,
): HttpResponsePromise<void>
Delete a session by ID.
Parameters
- id: string
  ID of the session to delete.
- OptionalrequestOptions: SessionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.sessions.delete("id")
```

update

update(
    id: string,
    request?: UpdateSessionRequestContent,
    requestOptions?: SessionsClient.RequestOptions,
): HttpResponsePromise<UpdateSessionResponseContent>
Update session information.
Parameters
- id: string
  ID of the session to update.
- request: UpdateSessionRequestContent = {}
- OptionalrequestOptions: SessionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateSessionResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.sessions.update("id")
```

revoke

revoke(
id: string,
requestOptions?: SessionsClient.RequestOptions,
): HttpResponsePromise<void>
Revokes a session by ID and all associated refresh tokens.
Parameters
- id: string
  ID of the session to revoke.
- OptionalrequestOptions: SessionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.sessions.revoke("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class SessionsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns SessionsClient

Methods

get

Parameters

Returns HttpResponsePromise<GetSessionResponseContent>

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateSessionResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

revoke

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

`Protected` `Readonly`_options