TrustedClaimIssuers

Handles all Security Token Default Trusted Claim Issuers related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ TrustedClaimIssuers

Index

Properties

• context

• parent

Methods

• add

• get

• remove

• set

Properties

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

Protected parent

• parent: SecurityToken

Inherited from void

Defined in src/api/entities/Namespace.ts:9

Methods

add

▸ add(args: ModifyTokenTrustedClaimIssuersAddSetParams): Promise‹TransactionQueue‹SecurityToken››

Defined in src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:45

Add the supplied Identities to the Security Token's list of trusted claim issuers

Parameters:

Name	Type
args	ModifyTokenTrustedClaimIssuersAddSetParams

Returns: Promise‹TransactionQueue‹SecurityToken››

get

▸ get(): Promise‹DefaultTrustedClaimIssuer[]›

Defined in src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:81

Retrieve the current default trusted claim issuers of the Security Token

note can be subscribed to

Returns: Promise‹DefaultTrustedClaimIssuer[]›

▸ get(callback: SubCallback‹DefaultTrustedClaimIssuer[]›): Promise‹UnsubCallback›

Defined in src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:82

Parameters:

Name	Type
callback	SubCallback‹DefaultTrustedClaimIssuer[]›

Returns: Promise‹UnsubCallback›

remove

▸ remove(args: ModifyTokenTrustedClaimIssuersRemoveParams): Promise‹TransactionQueue‹SecurityToken››

Defined in src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:63

Remove the supplied Identities from the Security Token's list of trusted claim issuers *

Parameters:

Name	Type
args	ModifyTokenTrustedClaimIssuersRemoveParams

Returns: Promise‹TransactionQueue‹SecurityToken››

set

▸ set(args: ModifyTokenTrustedClaimIssuersAddSetParams): Promise‹TransactionQueue‹SecurityToken››

Defined in src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:27

Assign a new default list of trusted claim issuers to the Security Token by replacing the existing ones with the list passed as a parameter

This requires two transactions

Parameters:

Name	Type
args	ModifyTokenTrustedClaimIssuersAddSetParams

Returns: Promise‹TransactionQueue‹SecurityToken››