Documentation

Mistake on this page? Email us

Account Account

Hierarchy

Index

Constructors

constructor

Properties

addressLine1

addressLine1: string

Postal address line 1.

example

110 Fulbourn Rd

addressLine2

addressLine2: string

Postal address line 2.

example

adminEmail

adminEmail: string

The email address of the admin user created for this account. Present only in the response for account creation.

example

admin@arm.com

adminFullName

adminFullName: string

The full name of the admin user created for this account. Present only in the response for account creation.

example

Admin Doe

adminId

adminId: string

The ID of the admin user created for this account. Present only in the response for the account creation.

example

01619571e2e89242ac12000600000000

adminKey

adminKey: string

The admin API key created for this account. Present only in the response for account creation.

example

ak_1MDE2MTk1NzFmNmU4MDI0MmFjMTIwMDA2MDAwMDAwMDA01619571f7020242ac12000600000000B40IkJADMANmAscAj0Ot0n2yeQnyt9tT

adminName

adminName: string

The username of the admin user created for this account. Present only in the response for account creation.

example

admin

adminPassword

adminPassword: string

The password of the admin user created for this account. Present only in the response for account creation.

example

PZf9eEUH43DAPE9ULINFeuj

aliases

aliases: Array<string>

aliases An array of aliases.

businessModel

businessModel: AccountBusinessModel

Business model for this account. Manageable by the root admin only.

example

api_calls_1_business_model

businessModelHistory

businessModelHistory: Array<any>

businessModelHistory

city

city: string

The city part of the postal address.

example

Cambridge

company

company: string

The name of the company.

example

ARM Holdings Plc

contact

contact: string

The name of the contact person for this account.

example

J. Doe

contractNumber

contractNumber: string

Contract number of the customer. Contract number of the customer

example

1NX25_0001

country

country: string

The country part of the postal address.

example

United Kingdom

createdAt

createdAt: Date

Creation UTC time RFC3339. Creation time.

example

2018-02-13T09:35:20Z

customFields

customFields: object

Account's custom properties as key-value pairs.

Type declaration

  • [key: string]: string

customerNumber

customerNumber: string

Customer number of the customer. Customer number of the customer

example

1NC25_0001

displayName

displayName: string

The display name for the account.

example

ARM

email

email: string

The company email address for this account.

example

info@arm.com

endMarket

endMarket: string

Account end market.

example

IT

expiration

expiration: Date

Expiration time of the account, as UTC time RFC3339.

expirationWarningThreshold

expirationWarningThreshold: number

Indicates how many days (1-180) before account expiration a notification email is sent.

example

180

expiryWarning

expiryWarning: string

The number of days before account expiration notification email should be sent

id

id: string

The unique identifier of the entity Account ID.

idleTimeout

idleTimeout: number

The reference token expiration time, in minutes, for this account.

example

30

limitations

limitations: Array<any>

This object represents an account limitation.

limits

limits: object

List of limits as key-value pairs if requested. List of limits as key-value pairs if requested.

Type declaration

  • [key: string]: string

mfaStatus

mfaStatus: AccountMfaStatus

The enforcement status of multi-factor authentication, either enforced or optional.

multifactorAuthenticationStatus

multifactorAuthenticationStatus: MultifactorAuthenticationStatusEnum

The enforcement status of the multi-factor authentication

notificationEmails

notificationEmails: Array<string>

notificationEmails

parentAccount

parentAccount: ParentAccount

Represents parent account contact details in responses.

parentId

parentId: string

The ID of the parent account, if any.

example

01619571dad80242ac12000600000000

passwordPolicy

passwordPolicy: PasswordPolicy

The password policy for this account.

passwordRecoveryExpiration

passwordRecoveryExpiration: number

Indicates for how many minutes a password recovery email is valid.

phoneNumber

phoneNumber: string

The phone number of a company representative.

example

+44 (1223) 400 400

policies

policies: Array<Policy>

Represents a feature policy. Either the feature or the resource must be specified. List of policies if requested.

postalCode

postalCode: string

The postal code part of the postal address.

example

CB1 9NJ

postcode

postcode: string

The postal code part of the postal address.

reason

reason: string

A note with the reason for account status update. A reason note for updating the status of the account.

example

Subscription paid.

referenceNote

referenceNote: string

A reference note for updating the status of the account. Reference note for updating the status of the account

example

ARM-INT-0001

salesContact

salesContact: string

Email address of the sales contact.

example

sales@arm.com

salesContactEmail

salesContactEmail: string

Email address of the sales contact.

state

state: string

The state part of the postal address.

example

status

The status of the account. The status of the account.

example

ACTIVE

templateId

templateId: string

Account template ID. Account template ID.

example

01619571e7160242ac12000600000000

tier

tier: string

The tier level of the account; 0: free tier, 1: commercial account, 2: partner tier. Other values are reserved for the future. The tier level of the account; '0': free tier, '1': commercial account. Other values are reserved for the future.

example

1

updatedAt

updatedAt: Date

Last update UTC time RFC3339. The last update time

example

2018-02-14T15:24:14Z

upgradedAt

upgradedAt: Date

Time when upgraded to commercial account in UTC format RFC3339. Time when upgraded to commercial account.

example

2018-02-14T15:24:14Z

Methods

update

  • update(): Promise<Account>
  • Update details of the account

    Returns Promise<Account>

    Promise of account

  • Update details of the account

    Parameters

    • callback: CallbackFn<Account>

      A function that is passed the return arguments (error, account)

    Returns void