Skip to content

api.client.Identities.Identities

prashantasdeveloper edited this page Apr 16, 2024 · 37 revisions

Class: Identities

api/client/Identities.Identities

Handles all Identity related functionality

Table of contents

Methods

Methods

allowIdentityToCreatePortfolios

allowIdentityToCreatePortfolios(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Gives permission to the Identity to create Portfolios on behalf of the signing Identity

Parameters

Name Type
args AllowIdentityToCreatePortfoliosParams
opts? ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Throws

if

  • the provided Identity already has permissions to create portfolios for signing Identity
  • the provided Identity does not exist

Note

this method is of type ProcedureMethod, which means you can call allowIdentityToCreatePortfolios.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/client/Identities.ts:222


attestPrimaryKeyRotation

attestPrimaryKeyRotation(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Get CDD Provider's attestation to change primary key

Parameters

Name Type
args AttestPrimaryKeyRotationParams
opts? ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Note

the transaction signer must be a CDD provider

Note

this creates an Authorization Requests which have to be accepted by the targetAccount along with the authorization for RotatingPrimaryKey. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

Note

required role:

  • Customer Due Diligence Provider

Note

this method is of type ProcedureMethod, which means you can call attestPrimaryKeyRotation.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/client/Identities.ts:129


createChild

createChild(args, opts?): Promise<GenericPolymeshTransaction<ChildIdentity, ChildIdentity>>

Creates a child identity and makes the secondaryKey as the primary key of the child identity

Parameters

Name Type
args CreateChildIdentityParams
opts? ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<ChildIdentity, ChildIdentity>>

Note

the given secondaryKey is removed as secondary key from the signing Identity

Throws

if

  • the transaction signer is not the primary account of which the secondaryKey is a secondary key
  • the secondaryKey can't be unlinked (can happen when it's part of a multisig with some balance)
  • the signing account is not a primary key
  • the signing Identity is already a child of some other identity

Note

this method is of type ProcedureMethod, which means you can call createChild.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/client/Identities.ts:208


createPortfolio

createPortfolio(args, opts?): Promise<GenericPolymeshTransaction<NumberedPortfolio[], NumberedPortfolio>>

Create a new Portfolio under the ownership of the signing Identity

Parameters

Name Type
args Object
args.name string
args.ownerDid? string
opts? ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<NumberedPortfolio[], NumberedPortfolio>>

Note

the ownerDid is optional. If provided portfolios will be created as Custody Portfolios under the ownerDid

Note

this method is of type ProcedureMethod, which means you can call createPortfolio.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/client/Identities.ts:154


createPortfolios

createPortfolios(args, opts?): Promise<GenericPolymeshTransaction<NumberedPortfolio[], NumberedPortfolio[]>>

Creates a set of new Portfolios under the ownership of the signing Identity

Parameters

Name Type
args Object
args.names string[]
args.ownerDid? string
opts? ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<NumberedPortfolio[], NumberedPortfolio[]>>

Note

the ownerDid is optional. If provided portfolios will be created as Custody Portfolios under the ownerDid

Note

this method is of type ProcedureMethod, which means you can call createPortfolios.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/client/Identities.ts:165


getAllowedCustodians

getAllowedCustodians(did): Promise<string[]>

Returns a list of allowed custodian did(s) for Identity

Parameters

Name Type
did string | Identity

Returns

Promise<string[]>

Throws

if

  • the provided Identity does not exist

Defined in

api/client/Identities.ts:245


getChildIdentity

getChildIdentity(args): Promise<ChildIdentity>

Create a ChildIdentity instance from a DID

Parameters

Name Type
args Object
args.did string

Returns

Promise<ChildIdentity>

Throws

if there is no ChildIdentity with the passed DID

Defined in

api/client/Identities.ts:183


getIdentity

getIdentity(args): Promise<Identity>

Create an Identity instance from a DID

Parameters

Name Type
args Object
args.did string

Returns

Promise<Identity>

Throws

if there is no Identity with the passed DID

Defined in

api/client/Identities.ts:174


isIdentityValid

isIdentityValid(args): Promise<boolean>

Return whether the supplied Identity/DID exists

Parameters

Name Type
args Object
args.identity string | Identity

Returns

Promise<boolean>

Defined in

api/client/Identities.ts:190


registerIdentity

registerIdentity(args, opts?): Promise<GenericPolymeshTransaction<Identity, Identity>>

Register an Identity, possibly with a CDD claim

Parameters

Name Type
args RegisterIdentityParams
opts? ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<Identity, Identity>>

Note

the transaction signer must be a CDD provider

Note

this may create Authorization Requests which have to be accepted by the targetAccount. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

Note

required role:

  • Customer Due Diligence Provider

Note

this method is of type ProcedureMethod, which means you can call registerIdentity.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/client/Identities.ts:111


revokeIdentityToCreatePortfolios

revokeIdentityToCreatePortfolios(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Revokes permission from the Identity to create Portfolios on behalf of the signing Identity

Parameters

Name Type
args RevokeIdentityToCreatePortfoliosParams
opts? ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Throws

if

  • the provided Identity already does not have permissions to create portfolios for signing Identity
  • the provided Identity does not exist

Note

this method is of type ProcedureMethod, which means you can call revokeIdentityToCreatePortfolios.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/client/Identities.ts:236


rotatePrimaryKey

rotatePrimaryKey(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Creates an Authorization to rotate primary key of the signing Identity by the targetAccount

Parameters

Name Type
args RotatePrimaryKeyParams
opts? ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Note

this creates an Authorization Requests which have to be accepted by the targetAccount along with the optional CDD authorization generated by CDD provider attesting the rotation of primary key An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

Note

this method is of type ProcedureMethod, which means you can call rotatePrimaryKey.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/client/Identities.ts:143

Clone this wiki locally