Class IdentityService

This class allwos for managing external identifiers.

Hierarchy

IdentityService

Index

Constructors

constructor

Methods

Constructors

constructor

new IdentityService(client: IFetchClient): IdentityService

- Defined in src/identity/IdentityService.ts:10
Parameters
- client: IFetchClient
Returns IdentityService

Methods

create

create(identity: IExternalIdentity): Promise<IResult<IExternalIdentity>>

- Defined in src/identity/IdentityService.ts:65
Creates a new identity.
example
```
  const identity: IExternalIdentity = {
     type: 'type',
     externalId: '1'
   };

   (async () => {
     const {data, res} = await identityService.create(identity);
  })();
```
Parameters
- identity: IExternalIdentity
  
  Identity object with mandantory fragments.
Returns Promise<IResult<IExternalIdentity>>

Response wrapped in IResult

delete

delete(identity: IExternalIdentity): Promise<IResult<IExternalIdentity>>

- Defined in src/identity/IdentityService.ts:123
Removes an identity with given id.
example
```
  const identity: IExternalIdentity = {
     type: 'type',
     externalId: '1'
   };

   (async () => {
     const {data, res} = await identityService.delete(identity);
  })();
```
Parameters
- identity: IExternalIdentity
  
  Identity object with mandantory fragments.
Returns Promise<IResult<IExternalIdentity>>

Response wrapped in IResult

detail

detail(identity: IExternalIdentity): Promise<IResult<IExternalIdentity>>

- Defined in src/identity/IdentityService.ts:95
Gets the details of an identity.
example
```
   const identity: IExternalIdentity = {
     type: 'type',
     externalId: '1'
   };

   (async () => {
     const {data, res} = await identityService.detail(identity);
  })();
```
Parameters
- identity: IExternalIdentity
  
  Identity object with mandantory fragments.
Returns Promise<IResult<IExternalIdentity>>

Response wrapped in IResult

list

list(managedObjectId: string): Promise<IResultList<IExternalIdentity>>

- Defined in src/identity/IdentityService.ts:36
Gets the list of identities filtered by parameters.
example
```
 const filter: object = {
    pageSize: 100,
    withTotalPages: true
  };

  (async () => {
    const {data, res, paging} = await identityService.list(filter);
  })();
```
Parameters
- managedObjectId: string
Returns Promise<IResultList<IExternalIdentity>>

Response wrapped in IResultList

Generated using TypeDoc