Class CharacterPermissionsResource

Character permissions resource

See

https://www.swcombine.com/ws/v2.0/documentation/character/uid/permissions/ SW Combine API Documentation

Hierarchy (View Summary)

BaseResource
- CharacterPermissionsResource

Index

Constructors

Methods

Constructors

constructor

new CharacterPermissionsResource(http: HttpClient): CharacterPermissionsResource
Parameters
- http: HttpClient
Returns CharacterPermissionsResource
Inherited from BaseResource.constructor
- Defined in src/resources/BaseResource.ts:13

Methods

getScopes

getScopes(options: GetCharacterPermissionsOptions): Promise<string[]>
Get flat list of granted scope names
Parameters
- options: GetCharacterPermissionsOptions
Returns Promise<string[]>
Array of scope strings (e.g., ['CHARACTER_READ', 'MESSAGES_SEND'])
- Defined in src/resources/CharacterResource.ts:484

list

list(
options: GetCharacterPermissionsOptions,
): Promise<CharacterPermissionsResponse>
Get permissions granted to API client for this character
Parameters
- options: GetCharacterPermissionsOptions
Returns Promise<CharacterPermissionsResponse>
Full permissions response with scopes and expiration
Example
```
const perms = await client.character.permissions.list({ uid: '1:12345' });
const scopes = perms.permission[0]?.scopes.scope || [];
console.log('Granted scopes:', scopes.join(', '));
```
- Defined in src/resources/CharacterResource.ts:476