Interface AccountAttributes

Attributes associated with an user account.

Hierarchy

AccountAttributes

Index

Methods

addAddress addDevice addEmail addEntitlement addGroup addIms addLinkedAccount addPhoneNumber addPhoto addRole addX509Certificates getAddresses getDevices getDisplayName getEmails getEntitlements getGroups getIms getLinkedAccounts getLocale getMfaOptIn getName getNickName getPassword getPhoneNumbers getPhotos getPreferredLanguage getProfileUrl getRoles getTimeZone getTitle getUserName getUserType getX509certificates isActive removeAddress removeDevice removeEmail removeEntitlement removeGroup removeIms removeLinkedAccounts removePhoneNumber removePhoto removeRole removeX509Certificates replaceDevice with withActive withAddresses withDevices withDisplayName withEmails withEntitlements withGroups withIms withLinkedAccounts withLocale withName withNickName withOptInMfa withPassword withPhoneNumbers withPhotos withPreferredLanguage withProfileUrl withRoles withTimeZone withTitle withUserType withX509Certificates

Properties

addresses

addresses: ComplexAttribute

devices

devices: ComplexAttribute

displayName

displayName: null | string

locale

locale: null | string

mfaOptIn

mfaOptIn: null | OptInMfaAttributes

name

name: null | Name

nickName

nickName: null | string

password

password: null | string

phoneNumbers

phoneNumbers: ComplexAttribute

photos

photos: ComplexAttribute

preferredLanguage

preferredLanguage: null | string

profileUrl

profileUrl: null | string

roles

roles: ComplexAttribute

timeZone

timeZone: null | string

title

title: null | string

userName

userName: string

userType

userType: null | string

x509certificates

x509certificates: any

Methods

addAddress

addAddress(address: {
    country: null | string;
    formatted: null | string;
    locality: null | string;
    postalCode: null | string;
    region: null | string;
    streetAddress: null | string;
}): AccountAttributes
Parameters
- address: {
      country: null | string;
      formatted: null | string;
      locality: null | string;
      postalCode: null | string;
      region: null | string;
      streetAddress: null | string;
  }
  - country: null | string
  - formatted: null | string
  - locality: null | string
  - postalCode: null | string
  - region: null | string
  - streetAddress: null | string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4567

addDevice

addDevice(device: Device): AccountAttributes
Parameters
- device: Device
Returns AccountAttributes
- Defined in typescript-definitions.ts:4573

addEmail

addEmail(email: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- email: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4579

addEntitlement

addEntitlement(entitlement: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- entitlement: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4585

addGroup

addGroup(group: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- group: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4591

addIms

addIms(im: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- im: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4597

addLinkedAccount

addLinkedAccount(linkedAccount: LinkedAccount): AccountAttributes
Parameters
- linkedAccount: LinkedAccount
Returns AccountAttributes
- Defined in typescript-definitions.ts:4603

addPhoneNumber

addPhoneNumber(phoneNumber: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- phoneNumber: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4609

addPhoto

addPhoto(photo: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- photo: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4615

addRole

addRole(role: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- role: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4621

addX509Certificates

addX509Certificates(x509Certificates: any): AccountAttributes
Create a copy of this Attributes with an additional X509 certificate.
Parameters
- x509Certificates: any
Returns AccountAttributes
- Defined in typescript-definitions.ts:4628

getAddresses

getAddresses(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4630

getDevices

getDevices(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4634

getDisplayName

getDisplayName(): null | string
Returns null | string
- Defined in typescript-definitions.ts:4638

getEmails

getEmails(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4642

getEntitlements

getEntitlements(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4646

getGroups

getGroups(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4650

getIms

getIms(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4654

getLinkedAccounts

getLinkedAccounts(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4658

getLocale

getLocale(): null | string
Returns null | string
- Defined in typescript-definitions.ts:4662

getMfaOptIn

getMfaOptIn(): null | OptInMfaAttributes
Returns null | OptInMfaAttributes
- Defined in typescript-definitions.ts:4666

getName

getName(): null | Name
Returns null | Name
- Defined in typescript-definitions.ts:4670

getNickName

getNickName(): null | string
Returns null | string
- Defined in typescript-definitions.ts:4674

getPassword

getPassword(): null | string
Returns null | string
- Defined in typescript-definitions.ts:4678

getPhoneNumbers

getPhoneNumbers(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4682

getPhotos

getPhotos(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4686

getPreferredLanguage

getPreferredLanguage(): null | string
Returns null | string
- Defined in typescript-definitions.ts:4690

getProfileUrl

getProfileUrl(): null | string
Returns null | string
- Defined in typescript-definitions.ts:4694

getRoles

getRoles(): ComplexAttribute
Returns ComplexAttribute
- Defined in typescript-definitions.ts:4698

getTimeZone

getTimeZone(): null | string
Returns null | string
- Defined in typescript-definitions.ts:4702

getTitle

getTitle(): null | string
Returns null | string
- Defined in typescript-definitions.ts:4706

getUserName

getUserName(): string
Returns string
- Defined in typescript-definitions.ts:4710

getUserType

getUserType(): null | string
Returns null | string
- Defined in typescript-definitions.ts:4714

getX509certificates

getX509certificates(): any
Returns any
- Defined in typescript-definitions.ts:4718

isActive

isActive(): boolean
Returns boolean
- Defined in typescript-definitions.ts:4722

removeAddress

removeAddress(address: {
    country: null | string;
    formatted: null | string;
    locality: null | string;
    postalCode: null | string;
    region: null | string;
    streetAddress: null | string;
}): AccountAttributes
Parameters
- address: {
      country: null | string;
      formatted: null | string;
      locality: null | string;
      postalCode: null | string;
      region: null | string;
      streetAddress: null | string;
  }
  - country: null | string
  - formatted: null | string
  - locality: null | string
  - postalCode: null | string
  - region: null | string
  - streetAddress: null | string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4728

removeDevice

removeDevice(device: Device): AccountAttributes
Parameters
- device: Device
Returns AccountAttributes
- Defined in typescript-definitions.ts:4734

removeEmail

removeEmail(email: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- email: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4740

removeEntitlement

removeEntitlement(entitlement: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- entitlement: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4746

removeGroup

removeGroup(group: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- group: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4752

removeIms

removeIms(im: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- im: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4758

removeLinkedAccounts

removeLinkedAccounts(linkedAccount: LinkedAccount): AccountAttributes
Parameters
- linkedAccount: LinkedAccount
Returns AccountAttributes
- Defined in typescript-definitions.ts:4764

removePhoneNumber

removePhoneNumber(phoneNumber: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- phoneNumber: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4770

removePhoto

removePhoto(photo: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- photo: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4776

removeRole

removeRole(role: {
primary: boolean;
value: string;
}): AccountAttributes
Parameters
- role: {
  primary: boolean;
  value: string;
  }
  - primary: boolean
  - value: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4782

removeX509Certificates

removeX509Certificates(x509Certificates: any): AccountAttributes
Create a copy of this Attributes with the given X509 certificate removed.
Parameters
- x509Certificates: any
Returns AccountAttributes
- Defined in typescript-definitions.ts:4789

replaceDevice

replaceDevice(device: Device): AccountAttributes
Parameters
- device: Device
Returns AccountAttributes
- Defined in typescript-definitions.ts:4795

with

with(attribute: Attribute): AccountAttributes
Parameters
- attribute: Attribute
Returns AccountAttributes
- Defined in typescript-definitions.ts:4801

withActive

withActive(active: boolean): AccountAttributes
Parameters
- active: boolean
Returns AccountAttributes
- Defined in typescript-definitions.ts:4807

withAddresses

withAddresses(...addresses: {
    country: null | string;
    formatted: null | string;
    locality: null | string;
    postalCode: null | string;
    region: null | string;
    streetAddress: null | string;
}[]): AccountAttributes
Create a copy of this with the given addresses.
Parameters
- Rest ...addresses: {
      country: null | string;
      formatted: null | string;
      locality: null | string;
      postalCode: null | string;
      region: null | string;
      streetAddress: null | string;
  }[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4814

withDevices

withDevices(...devices: Device[]): AccountAttributes
Create a copy of this with the given devices.
Parameters
- Rest ...devices: Device[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4821

withDisplayName

withDisplayName(displayName: string): AccountAttributes
Parameters
- displayName: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4827

withEmails

withEmails(...emails: {
primary: boolean;
value: string;
}[]): AccountAttributes
Create a copy of this with the given emails.
Parameters
- Rest ...emails: {
  primary: boolean;
  value: string;
  }[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4834

withEntitlements

withEntitlements(...entitlements: {
primary: boolean;
value: string;
}[]): AccountAttributes
Create a copy of this with the given entitlements.
Parameters
- Rest ...entitlements: {
  primary: boolean;
  value: string;
  }[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4841

withGroups

withGroups(...groups: {
primary: boolean;
value: string;
}[]): AccountAttributes
Create a copy of this with the given groups.
Parameters
- Rest ...groups: {
  primary: boolean;
  value: string;
  }[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4848

withIms

withIms(...ims: {
primary: boolean;
value: string;
}[]): AccountAttributes
Create a copy of this with the given Ims.
Parameters
- Rest ...ims: {
  primary: boolean;
  value: string;
  }[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4855

withLinkedAccounts

withLinkedAccounts(...linkedAccounts: LinkedAccount[]): AccountAttributes
Create a copy of this with the given linked accounts.
Parameters
- Rest ...linkedAccounts: LinkedAccount[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4862

withLocale

withLocale(locale: string): AccountAttributes
Parameters
- locale: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4868

withName

withName(name: Name): AccountAttributes
Parameters
- name: Name
Returns AccountAttributes
- Defined in typescript-definitions.ts:4874

withNickName

withNickName(nickName: string): AccountAttributes
Parameters
- nickName: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4880

withOptInMfa

withOptInMfa(optInMfa: null | OptInMfaAttributes): AccountAttributes
Create a copy of this with the given linked accounts.
Parameters
- optInMfa: null | OptInMfaAttributes
Returns AccountAttributes
- Defined in typescript-definitions.ts:4887

withPassword

withPassword(password: string): AccountAttributes
Parameters
- password: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4893

withPhoneNumbers

withPhoneNumbers(...phoneNumbers: {
primary: boolean;
value: string;
}[]): AccountAttributes
Create a copy of this with the given phone numbers.
Parameters
- Rest ...phoneNumbers: {
  primary: boolean;
  value: string;
  }[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4900

withPhotos

withPhotos(...photos: {
primary: boolean;
value: string;
}[]): AccountAttributes
Create a copy of this with the given photos.
Parameters
- Rest ...photos: {
  primary: boolean;
  value: string;
  }[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4907

withPreferredLanguage

withPreferredLanguage(preferredLanguage: string): AccountAttributes
Parameters
- preferredLanguage: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4913

withProfileUrl

withProfileUrl(profileUrl: string): AccountAttributes
Parameters
- profileUrl: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4919

withRoles

withRoles(...roles: {
primary: boolean;
value: string;
}[]): AccountAttributes
Create a copy of this with the given roles.
Parameters
- Rest ...roles: {
  primary: boolean;
  value: string;
  }[]
Returns AccountAttributes
- Defined in typescript-definitions.ts:4926

withTimeZone

withTimeZone(timezone: string): AccountAttributes
Parameters
- timezone: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4932

withTitle

withTitle(title: string): AccountAttributes
Parameters
- title: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4938

withUserType

withUserType(userType: string): AccountAttributes
Parameters
- userType: string
Returns AccountAttributes
- Defined in typescript-definitions.ts:4944

withX509Certificates

withX509Certificates(certificates: any): AccountAttributes
Create a copy of this with the given X509 certificates.
Parameters
- certificates: any
Returns AccountAttributes
- Defined in typescript-definitions.ts:4951

Interface AccountAttributes

Hierarchy

Index

Properties

Methods

Properties

addresses

devices

displayName

emails

entitlements

groups

ims

linkedAccounts

locale

mfaOptIn

name

nickName

password

phoneNumbers

photos

preferredLanguage

profileUrl

roles

timeZone

title

userName

userType

x509certificates

Methods

addAddress

Parameters

address: { country: null | string; formatted: null | string; locality: null | string; postalCode: null | string; region: null | string; streetAddress: null | string; }

country: null | string

formatted: null | string

locality: null | string

postalCode: null | string

region: null | string

streetAddress: null | string

Returns AccountAttributes

addDevice

Parameters

device: Device

Returns AccountAttributes

addEmail

Parameters

email: { primary: boolean; value: string; }

primary: boolean

value: string

Returns AccountAttributes

addEntitlement

Parameters

entitlement: { primary: boolean; value: string; }

primary: boolean

value: string

Returns AccountAttributes

addGroup

Parameters

group: { primary: boolean; value: string; }

primary: boolean

value: string

Returns AccountAttributes

addIms

Parameters

im: { primary: boolean; value: string; }

primary: boolean

value: string

Returns AccountAttributes

addLinkedAccount

Parameters

linkedAccount: LinkedAccount

Returns AccountAttributes

addPhoneNumber

Parameters

phoneNumber: { primary: boolean; value: string; }

primary: boolean

value: string

Returns AccountAttributes

addPhoto

Parameters

address: {
country: null | string;
formatted: null | string;
locality: null | string;
postalCode: null | string;
region: null | string;
streetAddress: null | string;
}

email: {
primary: boolean;
value: string;
}

entitlement: {
primary: boolean;
value: string;
}

group: {
primary: boolean;
value: string;
}

im: {
primary: boolean;
value: string;
}

phoneNumber: {
primary: boolean;
value: string;
}

photo: {
primary: boolean;
value: string;
}

role: {
primary: boolean;
value: string;
}

address: {
country: null | string;
formatted: null | string;
locality: null | string;
postalCode: null | string;
region: null | string;
streetAddress: null | string;
}