Class Sessions

Index

Constructors

Methods

get delete revoke _getAuthorizationHeader

Properties

Constructors

constructor

new Sessions(_options: Sessions.Options): Sessions
Parameters
- _options: Sessions.Options
Returns Sessions

Methods

get

get(
id: string,
requestOptions?: Sessions.RequestOptions,
): HttpResponsePromise<GetSessionResponseContent>
Retrieve session information.
Parameters
- id: string
  ID of session to retrieve
- OptionalrequestOptions: Sessions.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?: Sessions.RequestOptions,
): HttpResponsePromise<void>
Delete a session by ID.
Parameters
- id: string
  ID of the session to delete.
- OptionalrequestOptions: Sessions.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")
```

revoke

revoke(
id: string,
requestOptions?: Sessions.RequestOptions,
): HttpResponsePromise<void>
Revokes a session by ID and all associated refresh tokens.
Parameters
- id: string
  ID of the session to revoke.
- OptionalrequestOptions: Sessions.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")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Sessions.Options