TrustedClaimIssuers
Handles all Security Token Default Trusted Claim Issuers related functionality
Hierarchy
Namespace‹SecurityToken›
↳ TrustedClaimIssuers
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Inherited from void
Defined in src/api/entities/Namespace.ts:11
Protected parent
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:97
Add the supplied Identities to the Security Token's list of trusted claim issuers
note required role:
Security Token Owner
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:
Returns: Promise‹TransactionQueue‹SecurityToken››
get
▸ get(): Promise‹DefaultTrustedClaimIssuer[]›
Defined in src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:119
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:120
Parameters:
Returns: Promise‹UnsubCallback›
remove
▸ remove(args: ModifyTokenTrustedClaimIssuersRemoveParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:110
Remove the supplied Identities from the Security Token's list of trusted claim issuers *
note required role:
Security Token Owner
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:
Returns: Promise‹TransactionQueue‹SecurityToken››
set
▸ set(args: ModifyTokenTrustedClaimIssuersAddSetParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:84
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 required role:
Security Token Owner
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:
Returns: Promise‹TransactionQueue‹SecurityToken››
Last updated