Class DefaultSudoEntitlementsAdminClient`Beta`

Client responsible for establishing entitlements of federated identities.

Implements

SudoEntitlementsAdminClient

Constructors

constructor

new DefaultSudoEntitlementsAdminClient(
apiKeyOrCred: string | Credential,
options?: DefaultSudoEntitlementsAdminClientOptions,
): DefaultSudoEntitlementsAdminClient
Parameters
- apiKeyOrCred: string | Credential
- Optionaloptions: DefaultSudoEntitlementsAdminClientOptions
Returns DefaultSudoEntitlementsAdminClient
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:789

Methods

addEntitlementsSequence

addEntitlementsSequence(
    newEntitlementsSequence: Omit<
        EntitlementsSequence,
        "createdAt"
        | "updatedAt"
        | "version",
    >,
): Promise<EntitlementsSequence>
Add a new entitlements sequence
Parameters
- newEntitlementsSequence: Omit<EntitlementsSequence, "createdAt" | "updatedAt" | "version">
  Definition of new entitlements sequence
Returns Promise<EntitlementsSequence>
The created entitlements sequence
Throws
InvalidArgumentError
- if the specified entitlements sequence name is invalid
Implementation of SudoEntitlementsAdminClient.addEntitlementsSequence
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:974

addEntitlementsSet

addEntitlementsSet(
newEntitlementsSet: NewEntitlementsSet,
): Promise<EntitlementsSet>
Add a new entitlements set
Parameters
- newEntitlementsSet: NewEntitlementsSet
  Definition of new entitlements set
Returns Promise<EntitlementsSet>
The created entitlements set
Throws
InvalidEntitlementsError
- Entitlements set contains one or more entitlements with unrecognized names
Implementation of SudoEntitlementsAdminClient.addEntitlementsSet
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:854

applyEntitlementsSequenceToUser

applyEntitlementsSequenceToUser(
    externalId: string,
    entitlementsSequenceName: string,
    transitionsRelativeTo?: Date,
    version?: number,
): Promise<ExternalUserEntitlements>
Apply entitlements sequence directly to a user

If a record for that user's entitlements sequence does not yet exist it will be created.
Parameters
- externalId: string
  External IDP user ID of user to apply entitlements sequence to
- entitlementsSequenceName: string
  Name of the entitlements sequence to apply to the user
- OptionaltransitionsRelativeTo: Date
- Optionalversion: number
  If specified, version of any current entitlements that must be matched
Returns Promise<ExternalUserEntitlements>
The effective entitlements for the user
Throws
AlreadyUpdatedError
- if the user's entitlements have been updated with a later version
Throws
EntitlementsSequenceNotFoundError
- If the entitlements sequence named is not defined
Throws
AlreadyUpdatedError
- Specified version is less than the current entitlements version
Throws
IllegalArgumentError
- Specified version is greater than the current entitlements version
Implementation of SudoEntitlementsAdminClient.applyEntitlementsSequenceToUser
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:1022

applyEntitlementsSequenceToUsers

applyEntitlementsSequenceToUsers(
    operations: {
        entitlementsSequenceName: string;
        externalId: string;
        transitionsRelativeTo?: Date;
        version?: number;
    }[],
): Promise<ExternalUserEntitlementsResult[]>
Apply entitlements sequence to users

Equivalent of multiple calls to applyEntitlementsSequenceToUser

If a record for any user's entitlements sequence does not yet exist it will be created.
Parameters
- operations: {
      entitlementsSequenceName: string;
      externalId: string;
      transitionsRelativeTo?: Date;
      version?: number;
  }[]
  Array of applyEntitlementsSequenceToUser operations to perform.
Returns Promise<ExternalUserEntitlementsResult[]>
The effective entitlements for the user
Throws
AlreadyUpdatedError
- if the user's entitlements have been updated with a later version
Throws
EntitlementsSequenceNotFoundError
- If the entitlements sequence named is not defined
Implementation of SudoEntitlementsAdminClient.applyEntitlementsSequenceToUsers
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:1038

applyEntitlementsSetToUser

applyEntitlementsSetToUser(
    externalId: string,
    entitlementsSetName: string,
    version?: number,
): Promise<ExternalUserEntitlements>
Apply entitlements set to a user

If a record for that user's entitlements does not yet exist it will be created.
Parameters
- externalId: string
  External IDP user ID of user to retrieve entitlements for
- entitlementsSetName: string
  Name of the entitlements set to apply to the user
- Optionalversion: number
  If specified, version of any current entitlements that must be matched
Returns Promise<ExternalUserEntitlements>
The effective entitlements for the user
Throws
EntitlementSetNotFoundError
- If the named entitlements set does not exist
Throws
AlreadyUpdatedError
- if the user's entitlements have been updated with a later version
Throws
AlreadyUpdatedError
- Specified version is less than the current entitlements version
Throws
IllegalArgumentError
- Specified version is greater than the current entitlements version
Implementation of SudoEntitlementsAdminClient.applyEntitlementsSetToUser
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:894

applyEntitlementsSetToUsers

applyEntitlementsSetToUsers(
    operations: {
        entitlementsSetName: string;
        externalId: string;
        version?: number;
    }[],
): Promise<ExternalUserEntitlementsResult[]>
Apply entitlements sets to users.

Equivalent of multiple calls to applyEntitlementsSetToUser

If a record for a user's entitlements does not yet exist it will be created.
Parameters
- operations: { entitlementsSetName: string; externalId: string; version?: number }[]
  Array of applyEntitlementsSetToUser operations to perform.
Returns Promise<ExternalUserEntitlementsResult[]>
The effective entitlements for the user
Throws
EntitlementSetNotFoundError
- If the named entitlements set does not exist
Throws
AlreadyUpdatedError
- if the user's entitlements have been updated with a later version
Implementation of SudoEntitlementsAdminClient.applyEntitlementsSetToUsers
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:908

applyEntitlementsToUser

applyEntitlementsToUser(
    externalId: string,
    entitlements: Entitlement[],
    version?: number,
): Promise<ExternalUserEntitlements>
Apply entitlements to a user

If a record for that user's entitlements does not yet exist it will be created.
Parameters
- externalId: string
  External IDP user ID of user to retrieve entitlements for
- entitlements: Entitlement[]
  The entitlements to apply to the user
- Optionalversion: number
  If specified, version of any current entitlements that must be matched
Returns Promise<ExternalUserEntitlements>
The effective entitlements for the user
Throws
InvalidEntitlementsError
- Entitlements contains one or more entitlements with unrecognized names
Throws
AlreadyUpdatedError
- Specified version is less than the current entitlements version
Throws
IllegalArgumentError
- Specified version is greater than the current entitlements version
Implementation of SudoEntitlementsAdminClient.applyEntitlementsToUser
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:921

applyEntitlementsToUsers

applyEntitlementsToUsers(
    operations: {
        entitlements: Entitlement[];
        externalId: string;
        version?: number;
    }[],
): Promise<ExternalUserEntitlementsResult[]>
Apply entitlements to users

Equivalent of multiple calls to applyEntitlementsToUser

If a record for any user's entitlements does not yet exist it will be created.
Parameters
- operations: { entitlements: Entitlement[]; externalId: string; version?: number }[]
  Array of applyEntitlementsToUser operations to perform.
Returns Promise<ExternalUserEntitlementsResult[]>
The effective entitlements for the user
Throws
InvalidEntitlementsError
- Entitlements contains one or more entitlements with unrecognized names
Implementation of SudoEntitlementsAdminClient.applyEntitlementsToUsers
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:934

applyExpendableEntitlementsToUser

applyExpendableEntitlementsToUser(
    externalId: string,
    expendableEntitlements: Entitlement[],
    requestId: string,
): Promise<ExternalUserEntitlements>
Apply an expendable entitlements delta to a user

If a record for the user's entitlements does not yet exist a NoEntitlementsForUserError is thrown. Call an applyEntitlements* method to assign entitlements before calling this method.
Parameters
- externalId: string
  External IDP user ID of user to retrieve entitlements for
- expendableEntitlements: Entitlement[]
  The expendable entitlements delta to apply to the user
- requestId: string
  Request of this delta. Repetition of requests for the same external ID with the same requestId are idempotent
Returns Promise<ExternalUserEntitlements>
The effective entitlements for the user

Throws
InvalidEntitlementsError Entitlements contains one or more entitlements with unrecognized names or that are not expendable entitlements.

Throws
NoEntitlementsForUserError User has not previously been assigned entitlements.

Throws
DuplicateEntitlementError expendableEntitlements refers to the same entitlement more than once.

Throws
NegativeEntitlementError expendableEntitlements would cause an expendable entitlement for the user to go negative.

Throws
OverflowedEntitlementError expendableEntitlements would cause an expendable entitlement for the user to exceed the maximum allowable value.
Implementation of SudoEntitlementsAdminClient.applyExpendableEntitlementsToUser
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:1057

getEntitlementDefinition

getEntitlementDefinition(
name: string,
): Promise<EntitlementDefinition | undefined>
Get an entitlement definition by entitlement name
Parameters
- name: string
  Name of the entitlement definition to return
Returns Promise<EntitlementDefinition | undefined>
Named entitlements definition or undefined if no entitlement definition of the specified name has been defined.
Implementation of SudoEntitlementsAdminClient.getEntitlementDefinition
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:820

getEntitlementsForUser

getEntitlementsForUser(
externalId: string,
): Promise<ExternalEntitlementsConsumption>
Get entitlements for a user
Parameters
- externalId: string
  External IDP user ID of user to retrieve entitlements for
Returns Promise<ExternalEntitlementsConsumption>
Entitlements consumption for the user.
Throws
NoEntitlementsError
- The user has no entitlements defined
Implementation of SudoEntitlementsAdminClient.getEntitlementsForUser
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:844

getEntitlementsSequence

getEntitlementsSequence(name: string): Promise<EntitlementsSequence | undefined>
Get an entitlements sequence
Parameters
- name: string
  Name of the entitlements sequence to return
Returns Promise<EntitlementsSequence | undefined>
Named entitlements sequence or undefined if no entitlements sequence of the specified name has been defined.
Implementation of SudoEntitlementsAdminClient.getEntitlementsSequence
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:951

getEntitlementsSet

getEntitlementsSet(name: string): Promise<EntitlementsSet | undefined>
Get an entitlements set
Parameters
- name: string
  Name of the entitlements set to return
Returns Promise<EntitlementsSet | undefined>
Named entitlements set or undefined if no entitlements set of the specified name has been defined.
Implementation of SudoEntitlementsAdminClient.getEntitlementsSet
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:800

listEntitlementDefinitions

listEntitlementDefinitions(
limit?: number,
nextToken?: string,
): Promise<EntitlementDefinitionConnection>
List all entitlement definitions

Call again with a token parameter to continue paginated listing
Parameters
- Optionallimit: number
  number of entitlement definitions to be returned per call
- OptionalnextToken: string
  Optional token from which to continue listing
Returns Promise<EntitlementDefinitionConnection>
Paginated list of entitlement definitions
Implementation of SudoEntitlementsAdminClient.listEntitlementDefinitions
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:833

listEntitlementsSequences

listEntitlementsSequences(
nextToken?: string,
): Promise<EntitlementsSequencesConnection>
List all entitlements sequences

Call again with a token parameter to continue paginated listing
Parameters
- OptionalnextToken: string
  Optional token from which to continue listing
Returns Promise<EntitlementsSequencesConnection>
Paginated list of entitlements sequences
Implementation of SudoEntitlementsAdminClient.listEntitlementsSequences
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:964

listEntitlementsSets

listEntitlementsSets(nextToken?: string): Promise<EntitlementsSetsConnection>
List all entitlements sets

Call again with a token parameter to continue paginated listing
Parameters
- OptionalnextToken: string
Returns Promise<EntitlementsSetsConnection>
Paginated list of entitlements sets
Implementation of SudoEntitlementsAdminClient.listEntitlementsSets
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:810

removeEntitledUser

removeEntitledUser(externalId: string): Promise<EntitledUser | undefined>
Remove entitlements and consumption records of the specified user.
Parameters
- externalId: string
  External IDP user ID of user to remove.
Returns Promise<EntitledUser | undefined>
The entitled user removed or undefined if the user is not found.
Implementation of SudoEntitlementsAdminClient.removeEntitledUser
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:1071

removeEntitlementsSequence

removeEntitlementsSequence(
name: string,
): Promise<EntitlementsSequence | undefined>
Remove entitlements sequence
Parameters
- name: string
  Name of entitlements sequence to remove
Returns Promise<EntitlementsSequence | undefined>
The entitlements sequence removed or undefined if entitlements sequence was not present
Implementation of SudoEntitlementsAdminClient.removeEntitlementsSequence
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:1010

removeEntitlementsSet

removeEntitlementsSet(name: string): Promise<EntitlementsSet | undefined>
Remove entitlements set
Parameters
- name: string
  Name of entitlements set to remove
Returns Promise<EntitlementsSet | undefined>
The entitlements set removed or undefined if entitlements set was not present
Implementation of SudoEntitlementsAdminClient.removeEntitlementsSet
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:882

setEntitlementsSequence

setEntitlementsSequence(
    newEntitlementsSequence: Omit<
        EntitlementsSequence,
        "createdAt"
        | "updatedAt"
        | "version",
    >,
): Promise<EntitlementsSequence>
Update an entitlements sequence
Parameters
- newEntitlementsSequence: Omit<EntitlementsSequence, "createdAt" | "updatedAt" | "version">
  Definition of new entitlements sequence
Returns Promise<EntitlementsSequence>
The updated entitlements sequence
Throws
InvalidArgumentError
- if the specified entitlements sequence name is invalid
Implementation of SudoEntitlementsAdminClient.setEntitlementsSequence
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:992

setEntitlementsSet

setEntitlementsSet(
newEntitlementsSet: NewEntitlementsSet,
): Promise<EntitlementsSet>
Update an entitlements set
Parameters
- newEntitlementsSet: NewEntitlementsSet
  Definition of new entitlements set
Returns Promise<EntitlementsSet>
The updated entitlements set
Throws
InvalidEntitlementsError
- Entitlements set contains one or more entitlements with unrecognized names
Implementation of SudoEntitlementsAdminClient.setEntitlementsSet
- Defined in src/entitlementsAdmin/entitlementsAdminClient.ts:868

Class DefaultSudoEntitlementsAdminClientBeta

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DefaultSudoEntitlementsAdminClient

Methods

addEntitlementsSequence

Parameters

Returns Promise<EntitlementsSequence>

Throws

addEntitlementsSet

Parameters

Returns Promise<EntitlementsSet>

Throws

applyEntitlementsSequenceToUser

Parameters

Returns Promise<ExternalUserEntitlements>

Throws

Throws

Throws

Throws

applyEntitlementsSequenceToUsers

Parameters

Returns Promise<ExternalUserEntitlementsResult[]>

Throws

Throws

applyEntitlementsSetToUser

Parameters

Returns Promise<ExternalUserEntitlements>

Throws

Throws

Throws

Throws

applyEntitlementsSetToUsers

Parameters

Returns Promise<ExternalUserEntitlementsResult[]>

Throws

Throws

applyEntitlementsToUser

Parameters

Returns Promise<ExternalUserEntitlements>

Throws

Throws

Throws

applyEntitlementsToUsers

Parameters

Returns Promise<ExternalUserEntitlementsResult[]>

Throws

applyExpendableEntitlementsToUser

Parameters

Returns Promise<ExternalUserEntitlements>

Throws

Throws

Throws

Throws

Throws

getEntitlementDefinition

Parameters

Returns Promise<EntitlementDefinition | undefined>

getEntitlementsForUser

Parameters

Returns Promise<ExternalEntitlementsConsumption>

Throws

getEntitlementsSequence

Parameters

Returns Promise<EntitlementsSequence | undefined>

getEntitlementsSet

Parameters

Returns Promise<EntitlementsSet | undefined>

listEntitlementDefinitions

Parameters

Returns Promise<EntitlementDefinitionConnection>

listEntitlementsSequences

Parameters

Returns Promise<EntitlementsSequencesConnection>

listEntitlementsSets

Class DefaultSudoEntitlementsAdminClient`Beta`