# Interface: IIdentityProfileConnector\<T, U\>

Interface describing a contract which provides profile operations.

## Extends

- `IComponent`

## Type Parameters

### T

`T` *extends* `IJsonLdDocument` = `IJsonLdDocument`

### U

`U` *extends* `IJsonLdDocument` = `IJsonLdDocument`

## Methods

### create() {#create}

> **create**(`identity`, `publicProfile?`, `privateProfile?`): `Promise`\<`void`\>

Create the profile properties for an identity.

#### Parameters

##### identity

`string`

The identity of the profile to create.

##### publicProfile?

`T`

The public profile data as JSON-LD.

##### privateProfile?

`U`

The private profile data as JSON-LD.

#### Returns

`Promise`\<`void`\>

A promise that resolves when the profile has been created.

***

### get() {#get}

> **get**(`identity`, `publicPropertyNames?`, `privatePropertyNames?`): `Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>

Get the profile properties for an identity.

#### Parameters

##### identity

`string`

The identity of the item to get.

##### publicPropertyNames?

keyof `T`[]

The public properties to get for the profile, defaults to all.

##### privatePropertyNames?

keyof `U`[]

The private properties to get for the profile, defaults to all.

#### Returns

`Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>

The identity profile, will only return private data if you have correct permissions.

***

### update() {#update}

> **update**(`identity`, `publicProfile?`, `privateProfile?`): `Promise`\<`void`\>

Update the profile properties of an identity.

#### Parameters

##### identity

`string`

The identity to update.

##### publicProfile?

`T`

The public profile data as JSON-LD.

##### privateProfile?

`U`

The private profile data as JSON-LD.

#### Returns

`Promise`\<`void`\>

A promise that resolves when the profile has been updated.

***

### remove() {#remove}

> **remove**(`identity`): `Promise`\<`void`\>

Delete the profile for an identity.

#### Parameters

##### identity

`string`

The identity to delete.

#### Returns

`Promise`\<`void`\>

A promise that resolves when the profile has been removed.

***

### list() {#list}

> **list**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>

Get a list of the requested identities.

#### Parameters

##### publicFilters?

`object`[]

The filters to apply to the identities public profiles.

##### privateFilters?

`object`[]

The filters to apply to the identities private profiles.

##### publicPropertyNames?

keyof `T`[]

The public properties to get for the profile, defaults to all.

##### privatePropertyNames?

keyof `U`[]

The private properties to get for the profile, defaults to all.

##### cursor?

`string`

The cursor for paged requests.

##### limit?

`number`

The maximum number of items in a page.

#### Returns

`Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>

The list of items and cursor for paging.