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, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››

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

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

note this method is of type ProcedureMethod, which means you can call add.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	ModifyTokenTrustedClaimIssuersAddSetParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹SecurityToken››

get

▸ get(): Promise‹DefaultTrustedClaimIssuer[]›

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

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:111

Parameters:

Name	Type
callback	SubCallback‹DefaultTrustedClaimIssuer[]›

Returns: Promise‹UnsubCallback›

remove

▸ remove(args: ModifyTokenTrustedClaimIssuersRemoveParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››

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

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

note this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	ModifyTokenTrustedClaimIssuersRemoveParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹SecurityToken››

set

▸ set(args: ModifyTokenTrustedClaimIssuersAddSetParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››

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

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

note this method is of type ProcedureMethod, which means you can call set.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	ModifyTokenTrustedClaimIssuersAddSetParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹SecurityToken››