Documentation

Mistake on this page? Email us

AggregatorAccountAdminApi

Hierarchy

  • ApiBase
    • AggregatorAccountAdminApi

Index

Constructors

constructor

  • Parameters

    • Optional options: ConnectionOptions
    • Default value responseHandler: function =¬†null
        • (sdkError: SDKError, response: superagent.Response): any
        • Parameters

          • sdkError: SDKError
          • response: superagent.Response

          Returns any

    Returns AggregatorAccountAdminApi

Methods

addAccountApiKeyToGroups

  • addAccountApiKeyToGroups(accountID: string, apiKey: string, body: Array<string>, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Add API key to a list of groups. An endpoint for adding API key to groups.

    Parameters

    • accountID: string

      Account ID.

    • apiKey: string

      The ID of the API key to be added to the group.

    • body: Array<string>

      A list of IDs of the groups to be updated.

    • Optional callback: function
        • (error: any, data?: UpdatedResponse, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdatedResponse
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

addAccountCertificate

  • addAccountCertificate(accountID: string, body: TrustedCertificateRootReq, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Upload new trusted certificate. An endpoint for uploading new trusted certificates.

    Parameters

    • accountID: string

      Account ID.

    • body: TrustedCertificateRootReq

      A trusted certificate object with attributes, signature is optional.

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

addAccountUserToGroups

  • addAccountUserToGroups(accountID: string, userId: string, body: Array<string>, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Add user to a list of groups. An endpoint for adding user to groups.

    Parameters

    • accountID: string

      Account ID.

    • userId: string

      The ID of the user to be added to the group.

    • body: Array<string>

      A list of IDs of the groups to be updated.

    • Optional callback: function
        • (error: any, data?: UpdatedResponse, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdatedResponse
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

addSubjectsToAccountGroup

  • addSubjectsToAccountGroup(accountID: string, groupID: string, body: SubjectList, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Add members to a group. An endpoint for adding users and API keys to groups.

    Parameters

    • accountID: string

      Account ID.

    • groupID: string

      The ID of the group to be updated.

    • body: SubjectList

      A list of users and API keys to be added to the group.

    • Optional callback: function
        • (error: any, data?: UpdatedResponse, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdatedResponse
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

checkAccountApiKey

  • checkAccountApiKey(accountID: string, apiKey: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Check the API key. An endpoint for checking API key.

    Parameters

    • accountID: string

      Account ID.

    • apiKey: string

      The API key to be checked.

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

complete

  • complete(error: any, response: any, acceptHeader: string, callback?: function): void
  • Parameters

    • error: any
    • response: any
    • acceptHeader: string
    • Optional callback: function
        • Parameters

          Returns any

    Returns void

createAccount

  • createAccount(body: AccountCreationReq, action?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Create a new account. An endpoint for creating a new account.

    Parameters

    • body: AccountCreationReq

      Details of the account to be created.

    • Optional action: string

      Action, either 'create' or 'enroll'. <ul><li>'create' creates the account where its admin user has ACTIVE status if admin_password was defined in the request, or RESET status if no admin_password was defined. If the user already exists, its status is not modified. </li><li>'enroll' creates the account where its admin user has ENROLLING status. If the user already exists, its status is not modified. Email to finish the enrollment or to notify the existing user about the new account is sent to the admin_email defined in the request. </li></ul>

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

createAccountApiKey

  • createAccountApiKey(accountID: string, body: ApiKeyInfoReq, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Create a new API key. An endpoint for creating a new API key. There is no default value for the owner ID and it must be from the same account where the new API key is created.

    Parameters

    • accountID: string

      Account ID.

    • body: ApiKeyInfoReq

      Details of the API key to be created.

    • Optional callback: function
        • (error: any, data?: ApiKeyInfoResp, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: ApiKeyInfoResp
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

createAccountGroup

  • createAccountGroup(accountID: string, body: GroupCreationInfo, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Create a new group. An endpoint for creating a new group.

    Parameters

    • accountID: string

      Account ID.

    • body: GroupCreationInfo

      Details of the group to be created.

    • Optional callback: function
        • (error: any, data?: GroupSummary, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: GroupSummary
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

createAccountUser

  • createAccountUser(accountID: string, body: UserInfoReq, action?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Create a new user. An endpoint for creating or inviting a new user to the account. In case of invitation email address is used only, other attributes are set in the 2nd step.

    Parameters

    • accountID: string

      Account ID.

    • body: UserInfoReq

      A user object with attributes.

    • Optional action: string

      Create or invite user.

    • Optional callback: function
        • (error: any, data?: UserInfoResp, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UserInfoResp
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

currentConfig

  • currentConfig(): object
  • Returns the current configuration of this API module

    Returns object

    • apiKey: any
    • host: any

deleteAccountApiKey

  • deleteAccountApiKey(accountID: string, apiKey: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Delete the API key. An endpoint for deleting an API key.

    Parameters

    • accountID: string

      Account ID.

    • apiKey: string

      The ID of the API key to be deleted.

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deleteAccountCertificate

  • deleteAccountCertificate(accountID: string, certId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Delete trusted certificate by ID. An endpoint for deleting the trusted certificate.

    Parameters

    • accountID: string

      Account ID.

    • certId: string

      The ID of the trusted certificate to be deleted.

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deleteAccountGroup

  • deleteAccountGroup(accountID: string, groupID: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Delete a group. An endpoint for deleting a group.

    Parameters

    • accountID: string

      Account ID.

    • groupID: string

      The ID of the group to be deleted.

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

deleteAccountUser

  • deleteAccountUser(accountID: string, userId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Delete a user. An endpoint for deleting a user.

    Parameters

    • accountID: string

      Account ID.

    • userId: string

      The ID of the user to be deleted.

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAccountApiKey

  • getAccountApiKey(accountID: string, apiKey: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get API key details. An endpoint for retrieving API key details.

    Parameters

    • accountID: string

      Account ID.

    • apiKey: string

      The ID of the API key to be retrieved.

    • Optional callback: function
        • (error: any, data?: ApiKeyInfoResp, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: ApiKeyInfoResp
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAccountCertificate

  • getAccountCertificate(accountID: string, certId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get trusted certificate by ID. An endpoint for retrieving a trusted certificate by ID.

    Parameters

    • accountID: string

      Account ID.

    • certId: string

      The ID of the trusted certificate to be retrieved.

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAccountGroupSummary

  • getAccountGroupSummary(accountID: string, groupID: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get group information. An endpoint for getting general information about the group.

    Parameters

    • accountID: string

      Account ID.

    • groupID: string

      The ID of the group to be retrieved.

    • Optional callback: function
        • (error: any, data?: GroupSummary, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: GroupSummary
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAccountInfo

  • getAccountInfo(accountID: string, include?: string, properties?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get account info. Returns detailed information about the account.

    Parameters

    • accountID: string

      The ID of the account to be fetched.

    • Optional include: string

      Comma separated additional data to return. Currently supported: limits, policies, sub_accounts

    • Optional properties: string

      Property name to be returned from account specific properties.

    • Optional callback: function
        • (error: any, data?: AccountInfo, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: AccountInfo
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAccountUser

  • getAccountUser(accountID: string, userId: string, properties?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Details of the user. An endpoint for retrieving details of the user.

    Parameters

    • accountID: string

      Account ID.

    • userId: string

      The ID of the user to be retrieved.

    • Optional properties: string

      Request to return account specific user property values according to the given property name.

    • Optional callback: function
        • (error: any, data?: UserInfoResp, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UserInfoResp
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAllAccountApiKeys

  • getAllAccountApiKeys(accountID: string, limit?: number, after?: string, order?: string, include?: string, keyEq?: string, ownerEq?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get all API keys. An endpoint for retrieving the API keys in an array, optionally filtered by the owner.

    Parameters

    • accountID: string

      Account ID.

    • Optional limit: number

      The number of results to return (2-1000), default is 50.

    • Optional after: string

      The entity ID to fetch after the given one.

    • Optional order: string

      The order of the records based on creation time, ASC or DESC; by default ASC

    • Optional include: string

      Comma separated additional data to return. Currently supported: total_count

    • Optional keyEq: string

      API key filter.

    • Optional ownerEq: string

      Owner name filter.

    • Optional callback: function
        • Parameters

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAllAccountCertificates

  • getAllAccountCertificates(accountID: string, limit?: number, after?: string, order?: string, include?: string, nameEq?: string, serviceEq?: string, expireEq?: number, deviceExecutionModeEq?: number, deviceExecutionModeNeq?: number, ownerEq?: string, enrollmentModeEq?: boolean, issuerLike?: string, subjectLike?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get all trusted certificates. An endpoint for retrieving trusted certificates in an array.

    Parameters

    • accountID: string

      Account ID.

    • Optional limit: number

      The number of results to return (2-1000), default is 50.

    • Optional after: string

      The entity ID to fetch after the given one.

    • Optional order: string

      The order of the records based on creation time, ASC or DESC; by default ASC

    • Optional include: string

      Comma separated additional data to return. Currently supported: total_count

    • Optional nameEq: string

      Filter for certificate name

    • Optional serviceEq: string

      Filter for service

    • Optional expireEq: number

      Filter for expire

    • Optional deviceExecutionModeEq: number

      Filter for developer certificates

    • Optional deviceExecutionModeNeq: number

      Filter for not developer certificates

    • Optional ownerEq: string

      Owner name filter

    • Optional enrollmentModeEq: boolean

      Enrollment mode filter

    • Optional issuerLike: string

      Filter for issuer. Finds all matches where the filter value is a case insensitive substring of the result. Example: issuer__like=cn=iss matches CN=issuer.

    • Optional subjectLike: string

      Filter for subject. Finds all matches where the filter value is a case insensitive substring of the result. Example: subject__like=cn=su matches CN=subject.

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAllAccountGroups

  • getAllAccountGroups(accountID: string, limit?: number, after?: string, order?: string, include?: string, nameEq?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get all group information. An endpoint for retrieving all group information.

    Parameters

    • accountID: string

      Account ID.

    • Optional limit: number

      The number of results to return (2-1000), default is 50.

    • Optional after: string

      The entity ID to fetch after the given one.

    • Optional order: string

      The order of the records based on creation time, ASC or DESC; by default ASC

    • Optional include: string

      Comma separated additional data to return. Currently supported: total_count

    • Optional nameEq: string

      Filter for group name

    • Optional callback: function
        • Parameters

          • error: any
          • Optional data: GroupSummaryList
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAllAccountUsers

  • getAllAccountUsers(accountID: string, limit?: number, after?: string, order?: string, include?: string, emailEq?: string, statusEq?: string, statusIn?: string, statusNin?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get all user details. An endpoint for retrieving details of all users.

    Parameters

    • accountID: string

      Account ID.

    • Optional limit: number

      The number of results to return (2-1000), default is 50.

    • Optional after: string

      The entity ID to fetch after the given one.

    • Optional order: string

      The order of the records based on creation time, ASC or DESC; by default ASC

    • Optional include: string

      Comma separated additional data to return. Currently supported: total_count

    • Optional emailEq: string

      Filter for email address

    • Optional statusEq: string

      Filter for status

    • Optional statusIn: string

      An optional filter for getting users with a specified set of statuses.

    • Optional statusNin: string

      An optional filter for excluding users with a specified set of statuses.

    • Optional callback: function
        • Parameters

          • error: any
          • Optional data: UserInfoRespList
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getAllAccounts

  • getAllAccounts(statusEq?: string, statusIn?: string, statusNin?: string, tierEq?: string, parentEq?: string, endMarketEq?: string, countryLike?: string, limit?: number, after?: string, order?: string, include?: string, format?: string, properties?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get all accounts. Returns an array of account objects, optionally filtered by status and tier level.

    Parameters

    • Optional statusEq: string

      An optional filter for account status, ENROLLING, ACTIVE, RESTRICTED or SUSPENDED.

    • Optional statusIn: string

      An optional filter for getting accounts with a specified set of statuses.

    • Optional statusNin: string

      An optional filter for excluding accounts with a specified set of statuses.

    • Optional tierEq: string

      An optional filter for tier level, must be 0, 1, 2, 98, 99 or omitted.

    • Optional parentEq: string

      An optional filter for parent account ID.

    • Optional endMarketEq: string

      An optional filter for account end market.

    • Optional countryLike: string

      An optional filter for account country. Finds all matches where the filter value is a case insensitive substring of the result. Example: country__like=LAND matches Ireland.

    • Optional limit: number

      The number of results to return (2-1000), default is 1000.

    • Optional after: string

      The entity ID to fetch after the given one.

    • Optional order: string

      The order of the records based on creation time, ASC or DESC. Default value is ASC

    • Optional include: string

      Comma separated additional data to return. Currently supported: limits, policies, sub_accounts

    • Optional format: string

      Format information for the response to the query, supported: format=breakdown.

    • Optional properties: string

      Property name to be returned from account specific properties.

    • Optional callback: function
        • (error: any, data?: AccountInfoList, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: AccountInfoList
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getApiKeysOfAccountGroup

  • getApiKeysOfAccountGroup(accountID: string, groupID: string, limit?: number, after?: string, order?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get API keys of a group. An endpoint for listing the API keys of the group with details.

    Parameters

    • accountID: string

      Account ID.

    • groupID: string

      The ID of the group whose API keys are retrieved.

    • Optional limit: number

      The number of results to return (2-1000), default is 50.

    • Optional after: string

      The entity ID to fetch after the given one.

    • Optional order: string

      The order of the records based on creation time, ASC or DESC; by default ASC

    • Optional include: string

      Comma separated additional data to return. Currently supported: total_count

    • Optional callback: function
        • Parameters

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getGroupsOfAccountApikey

  • getGroupsOfAccountApikey(accountID: string, apiKey: string, limit?: number, after?: string, order?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get groups of the API key. An endpoint for retrieving groups of the API key.

    Parameters

    • accountID: string

      Account ID.

    • apiKey: string

      The ID of the API key whose details are retrieved.

    • Optional limit: number

      The number of results to return (2-1000), default is 50.

    • Optional after: string

      The entity ID to fetch after the given one.

    • Optional order: string

      The order of the records based on creation time, ASC or DESC; by default ASC

    • Optional include: string

      Comma separated additional data to return. Currently supported: total_count

    • Optional callback: function
        • Parameters

          • error: any
          • Optional data: GroupSummaryList
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getGroupsOfAccountUser

  • getGroupsOfAccountUser(accountID: string, userId: string, limit?: number, after?: string, order?: string, include?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get groups of the user. An endpoint for retrieving groups of the user.

    Parameters

    • accountID: string

      Account ID.

    • userId: string

      The ID of the user whose details are retrieved.

    • Optional limit: number

      The number of results to return (2-1000), default is 50.

    • Optional after: string

      The entity ID to fetch after the given one.

    • Optional order: string

      The order of the records based on creation time, ASC or DESC; by default ASC

    • Optional include: string

      Comma separated additional data to return. Currently supported: total_count

    • Optional callback: function
        • Parameters

          • error: any
          • Optional data: GroupSummaryList
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

getUsersOfAccountGroup

  • getUsersOfAccountGroup(accountID: string, groupID: string, limit?: number, after?: string, order?: string, include?: string, statusEq?: string, statusIn?: string, statusNin?: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Get users of a group. An endpoint for listing users of the group with details.

    Parameters

    • accountID: string

      Account ID.

    • groupID: string

      The ID of the group whose users are retrieved.

    • Optional limit: number

      The number of results to return (2-1000), default is 50.

    • Optional after: string

      The entity ID to fetch after the given one.

    • Optional order: string

      The order of the records based on creation time, ASC or DESC; by default ASC

    • Optional include: string

      Comma separated additional data to return. Currently supported: total_count

    • Optional statusEq: string

      An optional filter for getting users by status.

    • Optional statusIn: string

      An optional filter for getting users with a specified set of statuses.

    • Optional statusNin: string

      An optional filter for excluding users with a specified set of statuses.

    • Optional callback: function
        • Parameters

          • error: any
          • Optional data: UserInfoRespList
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

removeAccountApiKeyFromGroups

  • removeAccountApiKeyFromGroups(accountID: string, apiKey: string, body: Array<string>, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Remove API key from groups. An endpoint for removing API key from groups.

    Parameters

    • accountID: string

      Account ID.

    • apiKey: string

      The ID of the API key to be removed from the group.

    • body: Array<string>

      A list of IDs of the groups to be updated.

    • Optional callback: function
        • (error: any, data?: UpdatedResponse, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdatedResponse
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

removeAccountUserFromGroups

  • removeAccountUserFromGroups(accountID: string, userId: string, body: Array<string>, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Remove user from groups. An endpoint for removing user from groups.

    Parameters

    • accountID: string

      Account ID.

    • userId: string

      The ID of the user to be removed from the group.

    • body: Array<string>

      A list of IDs of the groups to be updated.

    • Optional callback: function
        • (error: any, data?: UpdatedResponse, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdatedResponse
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

removeApiKeysFromAccountGroup

  • removeApiKeysFromAccountGroup(accountID: string, groupID: string, body?: SubjectList, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Remove API keys from a group. An endpoint for removing API keys from groups.

    Parameters

    • accountID: string

      Account ID.

    • groupID: string

      A list of API keys to be removed from the group.

    • Optional body: SubjectList
    • Optional callback: function
        • (error: any, data?: UpdatedResponse, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdatedResponse
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

removeUsersFromAccountGroup

  • removeUsersFromAccountGroup(accountID: string, groupID: string, body?: SubjectList, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Remove users from a group. An endpoint for removing users from groups.

    Parameters

    • accountID: string

      Account ID.

    • groupID: string
    • Optional body: SubjectList
    • Optional callback: function
        • (error: any, data?: UpdatedResponse, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdatedResponse
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

request

  • request<T>(options: object, callback?: function): superagent.SuperAgentRequest
  • Type parameters

    • T

    Parameters

    • options: object
      • acceptTypes: Array<string>
      • Optional body?: any
      • contentTypes: Array<string>
      • Optional file?: boolean
      • formParams: __type
      • headers: object
        • [key: string]: string
      • method: string
      • query: __type
      • Optional requestOptions?: object
        • [key: string]: any
      • url: string
      • useFormData: boolean
    • Optional callback: function
        • Parameters

          Returns any

    Returns superagent.SuperAgentRequest

resetAccountApiKeySecret

  • resetAccountApiKeySecret(accountID: string, apiKey: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Reset the secret key. An endpoint for resetting the secret key of the API key.

    Parameters

    • accountID: string

      Account ID.

    • apiKey: string

      The ID of the API key to be reset.

    • Optional callback: function
        • (error: any, data?: ApiKeyInfoResp, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: ApiKeyInfoResp
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateAccount

  • updateAccount(accountID: string, body: AccountUpdateRootReq, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Update attributes of an existing account. An endpoint for updating an account.

    Parameters

    • accountID: string

      The ID of the account to be updated.

    • body: AccountUpdateRootReq

      Details of the account to be updated.

    • Optional callback: function
        • (error: any, data?: AccountInfo, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: AccountInfo
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateAccountApiKey

  • updateAccountApiKey(accountID: string, apiKey: string, body: ApiKeyUpdateReq, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Update API key details. An endpoint for updating API key details.

    Parameters

    • accountID: string

      Account ID.

    • apiKey: string

      The ID of the API key to be updated.

    • body: ApiKeyUpdateReq

      New API key attributes to be stored.

    • Optional callback: function
        • (error: any, data?: ApiKeyInfoResp, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: ApiKeyInfoResp
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateAccountCertificate

  • updateAccountCertificate(accountID: string, certId: string, body: TrustedCertificateUpdateReq, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Update trusted certificate. An endpoint for updating existing trusted certificates.

    Parameters

    • accountID: string

      Account ID.

    • certId: string

      The ID of the trusted certificate to be updated.

    • body: TrustedCertificateUpdateReq

      A trusted certificate object with attributes.

    • Optional callback: function
    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateAccountGroupName

  • updateAccountGroupName(accountID: string, groupID: string, body: GroupUpdateInfo, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Update the group name. An endpoint for updating a group name.

    Parameters

    • accountID: string

      Account ID.

    • groupID: string

      The ID of the group to be updated.

    • body: GroupUpdateInfo

      Details of the group to be created.

    • Optional callback: function
        • (error: any, data?: UpdatedResponse, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UpdatedResponse
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

updateAccountUser

  • updateAccountUser(accountID: string, userId: string, body: UserUpdateReq, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Update user details. An endpoint for updating user details.

    Parameters

    • accountID: string

      Account ID.

    • userId: string

      The ID of the user to be updated.

    • body: UserUpdateReq

      A user object with attributes.

    • Optional callback: function
        • (error: any, data?: UserUpdateResp, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: UserUpdateResp
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest

validateAccountUserEmail

  • validateAccountUserEmail(accountID: string, userId: string, callback?: function, requestOptions?: object): superagent.SuperAgentRequest
  • Validate the user email. An endpoint for validating the user email.

    Parameters

    • accountID: string

      Account ID.

    • userId: string

      The ID of the user whose email is validated.

    • Optional callback: function
        • (error: any, data?: any, response?: superagent.Response): any
        • Parameters

          • error: any
          • Optional data: any
          • Optional response: superagent.Response

          Returns any

    • Optional requestOptions: object
      • [key: string]: any

    Returns superagent.SuperAgentRequest