Struct IdentityCallApi 

pub struct IdentityCallApi<'api> { /* private fields */ }

Implementations

impl<'api> IdentityCallApi<'api>

pub fn cdd_register_did( &self, target_account: AccountId, secondary_keys: Vec<SecondaryKey<AccountId>>, ) -> Result<WrappedCall>

Register target_account with a new Identity.

Failure

• origin has to be an active DID registrar. Inactive DID registrars cannot register new identities.
• target_account (primary key of the new Identity) can be linked to just one and only one identity.
• External secondary keys can be linked to just one identity.

pub fn accept_primary_key(&self, rotation_auth_id: u64) -> Result<WrappedCall>

Call this with the new primary key. By invoking this method, caller accepts authorization to become the new primary key of the issuing identity. If a CDD service provider approved this change (or this is not required), primary key of the DID is updated.

The caller (new primary key) must be either a secondary key of the issuing identity, or unlinked to any identity.

Differs from rotate_primary_key_to_secondary in that it will unlink the old primary key instead of leaving it as a secondary key.

Arguments

• rotation_auth_id Authorization from the owner who initiated the change

pub fn join_identity_as_key(&self, auth_id: u64) -> Result<WrappedCall>

Join an identity as a secondary key.

pub fn leave_identity_as_key(&self) -> Result<WrappedCall>

Leave the secondary key’s identity.

pub fn add_claim( &self, target: IdentityId, claim: Claim, expiry: Option<u64>, ) -> Result<WrappedCall>

Adds a new claim record or edits an existing one.

Only called by did_issuer’s secondary key.

pub fn revoke_claim( &self, target: IdentityId, claim: Claim, ) -> Result<WrappedCall>

Marks the specified claim as revoked.

pub fn freeze_secondary_keys(&self) -> Result<WrappedCall>

It disables all secondary keys at did identity.

Errors

pub fn unfreeze_secondary_keys(&self) -> Result<WrappedCall>

Re-enables all secondary keys of the caller’s identity.

pub fn add_authorization( &self, target: Signatory<AccountId>, data: AuthorizationData<AccountId>, expiry: Option<u64>, ) -> Result<WrappedCall>

Adds an authorization.

pub fn remove_authorization( &self, target: Signatory<AccountId>, auth_id: u64, auth_issuer_pays: bool, ) -> Result<WrappedCall>

Removes an authorization. _auth_issuer_pays determines whether the issuer of the authorisation pays the transaction fee

pub fn gc_add_cdd_claim(&self, target: IdentityId) -> Result<WrappedCall>

Assuming this is executed by the GC voting majority, adds a new cdd claim record.

pub fn gc_revoke_cdd_claim(&self, target: IdentityId) -> Result<WrappedCall>

Assuming this is executed by the GC voting majority, removes an existing cdd claim record.

pub fn revoke_claim_by_index( &self, target: IdentityId, claim_type: ClaimType, scope: Option<Scope>, ) -> Result<WrappedCall>

Revokes a specific claim using its Claim Unique Index composed by target, claim_type, and scope.

Please note that origin must be the issuer of the target claim.

pub fn rotate_primary_key_to_secondary( &self, auth_id: u64, ) -> Result<WrappedCall>

Call this with the new primary key. By invoking this method, caller accepts authorization to become the new primary key of the issuing identity. If a CDD service provider approved this change, (or this is not required), primary key of the DID is updated.

The caller (new primary key) must be either a secondary key of the issuing identity, or unlinked to any identity.

Differs from accept_primary_key in that it will leave the old primary key as a secondary key with the permissions specified in the corresponding RotatePrimaryKeyToSecondary authorization instead of unlinking the old primary key.

Arguments

• auth_id Authorization from the owner who initiated the change

pub fn add_secondary_keys_with_authorization( &self, additional_keys: Vec<SecondaryKeyWithAuth<AccountId>>, expires_at: u64, ) -> Result<WrappedCall>

Adds secondary keys to target identity id.

Keys are directly added to identity because each of them has an authorization.

Arguments

• origin which must be the primary key of the identity id.
• additional_keys which includes secondary keys, coupled with authorization data, to add to target identity.
• expires_at expiration time for the authorizations.

Errors

• Can only called by primary key owner.
• Keys should be able to linked to any identity.

pub fn set_secondary_key_permissions( &self, key: AccountId, perms: Permissions, ) -> Result<WrappedCall>

Sets permissions for an specific target_key key.

Only the primary key of an identity is able to set secondary key permissions.

pub fn remove_secondary_keys( &self, keys_to_remove: Vec<AccountId>, ) -> Result<WrappedCall>

Removes specified secondary keys of a DID if present.

Errors

The extrinsic can only called by primary key owner.

pub fn register_custom_claim_type(&self, ty: Vec<u8>) -> Result<WrappedCall>

Register custom claim type.

Errors

• CustomClaimTypeAlreadyExists The type that is being registered already exists.
• CounterOverflow CustomClaimTypeId has overflowed.
• TooLong The type being registered is too lang.

pub fn cdd_register_did_with_cdd( &self, target_account: AccountId, secondary_keys: Vec<SecondaryKey<AccountId>>, expiry: Option<u64>, ) -> Result<WrappedCall>

Register target_account with a new Identity and issue a CDD claim with a blank CddId

Failure

• origin has to be an active DID registrar. Inactive DID registrars cannot register new identities.
• target_account (primary key of the new Identity) can be linked to just one and only one identity.
• External secondary keys can be linked to just one identity.

pub fn register_did(&self, target_account: AccountId) -> Result<WrappedCall>

Register a new DID for the target account.

Caller must be a DID registrar (formerly CDD provider). No CDD claim is added - DID existence is sufficient for onboarding.

Note: This extrinsic does NOT support secondary keys. Use the deprecated cdd_register_did if secondary keys are needed.

Failure

• origin has to be an active DID registrar. Inactive DID registrars cannot register new identities.
• target_account (primary key of the new Identity) can be linked to just one and only one identity.

pub fn self_register_did(&self) -> Result<WrappedCall>

Register for a new DID for the caller’s account.

This is callable by any account that is not already linked to an identity, and will create a new DID with the caller as the primary key. This allows users to self onboard without needing to go through a DID registrar (formerly CDD provider).

No CDD claim is added - DID existence is sufficient for onboarding.

Errors

• Caller must not already have an identity.

Trait Implementations

impl<'api> Clone for IdentityCallApi<'api>

fn clone(&self) -> IdentityCallApi<'api>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'api> From<&'api Api> for IdentityCallApi<'api>

fn from(api: &'api Api) -> Self

Converts to this type from the input type.