How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Armor Account Management API

The Account Management API from Armor — 47 operation(s) for account management.

Armor Account Management API is one of 70 APIs that Armor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 62 operations across 47 paths, and defines 61 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.armor.com.

62 operations 47 paths 61 schemas 6 DELETE37 GET1 PATCH15 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.armor.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Armor Account Management API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (Authorization). An API key is passed in the header as X-Account-Context (X-Account-Context).

  • Authorization — Authorization Token
  • X-Account-Context — X-Account-Context

Paths & Operations 62

Across 47 paths, the API surfaces 62 operations — 6 DELETE, 37 GET, 1 PATCH, 15 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Account Management 62
GET
/{entityType}/{entityId}/notes
Return notes for a given entity type and id. Notes provide a free text field that can be used to storage additional information about a given entity.
Notes_GetNoteAsync 2 params → 200400
PUT
/{entityType}/{entityId}/notes
Add or update notes for a given entity type and id. A free text field that can be used to store additional information about a given entity.
Notes_UpdateNoteAsync 2 params body → 200400
DELETE
/{entityType}/{entityId}/notes
Delete notes for a given entity type and id.
Notes_DeleteNoteAsync 2 params body → 200400
GET
/{entityType}/{entityId}/tags
Return tags for entity type and id. Tags are custom meta-data attributes that can be leveraged when searching for a given entity type.
Tags_GetTagsAsync 2 params → 200400
POST
/{entityType}/{entityId}/tags
Add tags for a given entity type and id.
Tags_AddTagAsync 2 params body → 200400
DELETE
/{entityType}/{entityId}/tags
Delete tags for a given entity type and id.
Tags_DeleteTagAsync 2 params body → 200400
GET
/account/activity/history
Retrieve list of Account Activity for your account.
AccountHistory_GetAccountActivityHistory → 200400500
GET
/account/children
Returns a list of child accounts associated to the parent account
ChildAccounts_GetAllChildAccounts → 200400500
POST
/account/children
Creates a child account
ChildAccounts_CreateChildAccount body → 200400500
POST
/account/children/massgrantaccess
Give mass access for Parent Account Users to Child Account
ChildAccounts_MassGrantAccess body → 200400500
GET
/account/contacts
This will return the list of Armor Contacts for the given Armor Account.
AccountContacts_GetContacts → 200400
GET
/account/pricing/{sku}
AccountSkuPricing_GetAccountPrice 1 param → 200
POST
/account/primary-user
Set Primary User for one or more notification types
PrimaryNotificationUser_UpdateAccountPrimaryBillingContact body → 200202400
GET
/accounts
Return a list of accounts and the products related to the account id.
Accounts_GetAccounts → 200400
POST
/accounts
Update the Account information.
Accounts_UpdateAccount body → 200400
GET
/accounts/{accountId}
Get the Account information.
Accounts_GetAccount 1 param → 200400
GET
/accounts/{accountId}/accountusersandrole
Get the users of an account and their roles
Accounts_GetAccountUsersAndRole 1 param → 200
GET
/accounts/{accountId}/roles
Get the Roles of an account
Accounts_GetRoles 1 param → 200
POST
/cloud-connections
Retrieve All Cloud Connections based on Account Id.
CloudConnections_CloudConnections body → 200400
GET
/cloud-connections/{connectionId}
Retrieve cloud connection detail by connection Id
CloudConnections_CloudConnectionDetails 1 param → 200400
DELETE
/cloud-connections/{connectionId}
Soft Delete Cloud Connection by Id.
CloudConnections_CloudConnection 1 param → 200400
GET
/cloud-connections/connections/isEnabled
Check whether any enabled cloud connections exist.
CloudConnections_CloudConnectionsEnabled → 200400
POST
/cloud-connections/savecloudconnection
Save cloud connection details.
CloudConnections_SaveCloudConnectionsDetails body → 200400
GET
/cloud-connections/servicetypes
Retrieve All Connection Service Types.
CloudConnections_AllServiceTypes → 200400
GET
/cloud-connections/summary
Cloud connectiion summary dto used by ngx-portal Returns cloud connection list for security hub
CloudConnections_CloudConnectionsSummary → 200400
GET
/internal/awssecurityhub/audits
Get AWS SecurityHub audit logs
InternalAWSSecurityHubAudit_GetAWSSecurityHubAuditsAsync → 200
GET
/internal/awssecurityhub/audits/{id}
Get AWS SecurityHub payload by Id
InternalAWSSecurityHubAudit_GetAuditsPayloadByIdAsync 1 param → 200
GET
/invoices
Retrieve invoices for an account.
Invoice_GetInvoices → 200400
GET
/invoices/{id}
Retrieve the invoice summary for an invoice.
Invoice_GetInvoiceSummary 1 param → 200400404
GET
/invoices/{id}/detail
Retrieve invoice export detail for an invoice.
Invoice_GetInvoicesDetail 1 param → 200400404
GET
/paymentmethods
Retrieve payment methods for an account.
PaymentMethod_GetPaymentMethods → 200
DELETE
/paymentmethods/{id}
Delete payment method from an account
PaymentMethod_DeletePaymentMethodById 1 param body → 200400
PATCH
/paymentmethods/{id}
Update payment method on an account.
PaymentMethod_SetDefaultPaymentMethod 1 param body → 200400
GET
/permissions
Get a list of all permissions available on the account.
Roles_GetPermissions → 200400
GET
/products
Retrieve any product lists that are associated to your Account.
ProductCatalog_GetProductLists → 200
GET
/products/{id}
Retrieve a specific product list that is associated to your Account.
ProductCatalog_GetProductList 1 param → 200400
GET
/products/{id}/{category}
Retrieve a filtered list of products specific to a category within a given product list on your Account.
ProductCatalog_GetProductListByCategory 2 params → 200400
GET
/products/{id}/resizeinstance
Retrieve a resizable list of products specific to a instance.
ProductCatalog_GetResizableInstanceProductList 1 param → 200400
GET
/roles
Get a list of all roles on an account, including the associated permissions and assigned users.
Roles_GetRoles → 200404
POST
/roles
Create a role with a group of permissions.
Roles_CreateRole body → 200400
GET
/roles/{id}
GET a role by the role id.
Roles_GetRole 1 param → 200404
POST
/roles/{id}
Update the name and/or permissions assigned to a role.
Roles_UpdateRole 1 param body → 200400
DELETE
/roles/{id}
Delete a role by id.
Roles_DeleteRole 1 param → 200404
POST
/roles/{id}/members/{userId}
Add a user to a role.
Roles_UpdateRoleMember 2 params → 200404
DELETE
/roles/{id}/members/{userId}
Delete a user from a role.
Roles_DeleteRoleMember 2 params → 200404
GET
/subscriptions
Retrieve subscriptions for an account.
Subscription_GetSubscriptions → 200
GET
/subscriptions/account-details
Get partner customer details for logged-in account.
SubscriptionUsage_GetAllAccountDetailsForPartner → 200
GET
/subscriptions/account-usage
Get account all usage for billing period.
SubscriptionUsage_GetAccountUsage → 200
GET
/subscriptions/account-usagedetails
Get usage details for partner and partner customers
SubscriptionUsage_GetAccountUsageDetails → 200
POST
/subscriptions/actions/cancel
Cancel an active subscription.
Subscription_CancelSubscription body → 200202
GET
/subscriptions/hourlyusage
Get partners and partner customers hourly usagedetails for logged-in account.
SubscriptionUsage_GetHourlyUsage → 200400500
GET
/usage
Retrieve Usage records for an account.
Usage_GetAccountUsage → 200400
GET
/users
Retrieve a list of users for an account.
Users_GetUsers → 200
POST
/users
Invite a new or existing user to an account.
Users_CreateAccountUser body → 200400
GET
/users/{id}
Get details about a specific user.
Users_GetUser 1 param → 200400
PUT
/users/{id}
Update the attributes of a user.
Users_UpdateUser 1 param body → 200400
POST
/users/{userId}/invite
Resend email invitation for an invited user.
Users_ResendAccountInvite 1 param → 200400
GET
/users/notifications
Get a user's notification settings. Notification settings determine the types of notifications a given user is subscribed to (e.g. Technical notifications, Ticket notifications, etc.).
Users_GetUserNotificationPreferences → 200
POST
/users/notifications
Update the notification settings for a user.
Users_CreateUserNotificationPreferences body → 200400
GET
/users/simpleUserList
Retrieve a simplified list of users for an account.
Users_GetUsersSimpleList → 200
POST
/users/status
Enable or disable a user on an account.
Users_UpdateUserStatus body → 200400
PUT
/usersecurity/challengephrase
Update the user challenge phrase for a given user account.
UserSecurity_UpdateChallengePhrase body → 200400

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are FireHost.Services.Http.Accounts.Models.ChildAccounts.ChildAccountSignupRequest (22 properties), FireHost.Services.Http.Billing.Models.ProductListItemModel (21 properties), FireHost.Infrastructure.Accounts.Data.Persistence.PaymentMethod (18 properties), FireHost.Services.Http.Accounts.Models.GetUserResponse (18 properties). Each schema is shown below with its type and property counts.

FireHost.Services.Http.Accounts.Models.UpdateUserStatusResponse
object
2 properties
FireHost.Services.Http.Meta.ApiExamples.Models.DeleteNoteSampleRequest
object
FireHost.Infrastructure.RBAC.Data.Domain.RoleUser
object
7 properties
FireHost.Services.Http.Billing.Models.Usage.AccountUsageResponse
object
4 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.SetDefaultPaymentMethodSampleRequest
object
1 property
FireHost.Services.Meta.ApiExamples.Models.AddTagSampleRequest
object
1 property
FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionServiceTypesDto
object
5 properties
FireHost.Services.Http.CloudConnections.Models.Requests.ServiceParams
object
1 property
FireHost.Infrastructure.Billing.Models.AccountHourlyUsageItem
object
5 properties
FireHost.Services.Http.Billing.Models.InvoiceSummary
object
16 properties
FireHost.Services.Http.Billing.Models.InvoiceAddress
object
8 properties
FireHost.Services.Http.Billing.Models.InvoiceSummaryLineItem
object
6 properties
FireHost.Services.Http.Accounts.Models.ChildAccounts.ChildAccountSignupRequest
object
Request object for Child Account Signup
22 properties
FireHost.Services.Http.Accounts.Data.Domain.SalesForceUser
object
15 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.AddUpdatePrimaryNotificationUserRequestSample
object
3 properties
FireHost.Infrastructure.Billing.Models.SubAccountDto
object
2 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.CreateUserNotificationPreferenceSampleRequest
object
4 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.CreateAccountUserSampleRequest
object
4 properties
FireHost.Services.Http.Accounts.Models.GetPermissionsResponse
object
2 properties
FireHost.Infrastructure.Accounts.Internal.Data.Requests.Role
object
1 property
FireHost.Services.Http.Accounts.Models.UserAccountDto
object
9 properties
FireHost.Infrastructure.Billing.Data.Persistence.ProductList
object
5 properties
FireHost.Services.Http.Billing.Models.InvoiceResponse
object
7 properties
FireHost.Services.Http.Accounts.Models.CreateAccountResponse
object
1 property
FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionDetailsDto
object
10 properties
FireHost.Infrastructure.Billing.Models.AccountListDto
object
2 properties
FireHost.Services.Http.Accounts.Models.GetAccountRolePermissionsResponse
object
7 properties
FireHost.Infrastructure.Accounts.Data.Phone
object
4 properties
FireHost.Services.Http.Billing.ApiExamples.Models.CancelSubscriptionSampleRequest
object
2 properties
FireHost.Services.Http.Accounts.Models.GetUserResponse
object
18 properties
FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionService
object
7 properties
FireHost.Services.Http.Accounts.Data.Domain.AccountContacts
object
2 properties
FireHost.Services.Meta.ApiExamples.Models.DeleteTagSampleRequest
object
1 property
FireHost.Services.Http.Accounts.ApiExamples.Models.DeletePaymentMethodByIdSampleRequest
object
1 property
FireHost.Services.Http.Billing.Models.Usage.AccountUsageItemDetails
object
17 properties
FireHost.Services.Meta.ApiExamples.Models.UpdateNoteSampleRequest
object
1 property
FireHost.Services.Common.Data.Domain.User.UserNotificationPreference
object
5 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.UserNotificationPreferenceSample
object
4 properties
FireHost.Services.Http.Billing.Models.SubscriptionResponse
object
11 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateAccountSampleRequest
object
6 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.SamplePhone
object
3 properties
FireHost.Services.Http.Accounts.Models.PermissionDto
object
6 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateUserSampleRequest
object
4 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateChallengePhraseSampleRequest
object
3 properties
FireHost.Services.Infrastructure.CloudConnections.Models.ConnectionSubServiceType
object
5 properties
FireHost.Services.Http.Accounts.Models.GetRolesResponse
object
Role Details
3 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateRoleSampleRequest
object
2 properties
FireHost.Services.Http.Billing.Models.ProductListItemModel
object
21 properties
FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionsDto
object
13 properties
FireHost.Infrastructure.Accounts.Data.Persistence.UserNotificationPreferencesResponse
object
1 property
FireHost.Services.Infrastructure.CloudConnections.Models.CloudConnectionsSummaryDto
object
6 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.UpdateUserStatusSampleRequest
object
3 properties
FireHost.Services.Http.Billing.Models.ProductItemLocationPrice
object
3 properties
FireHost.Services.Http.Accounts.Models.AccountDetail
object
9 properties
FireHost.Services.Http.Accounts.Models.GetUsageResponse
object
Model for Usage Data
5 properties
FireHost.Services.Http.Accounts.ApiExamples.Models.CreateRoleSampleRequest
object
2 properties
System.Object
object
FireHost.Services.Http.Accounts.Models.ChildAccounts.MassGrantAccessRequest
object
Request object for Mass Access for Parent Account Users to Child Account
4 properties
FireHost.Services.Http.Accounts.Models.PermissionEndpoint
object
2 properties
FireHost.Services.Http.Accounts.Models.GetRoleUser
object
7 properties
FireHost.Infrastructure.Accounts.Data.Persistence.PaymentMethod
object
18 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

armor-account-management-api-openapi.yml Raw ↑

Other APIs Armor publishes across the network.

Armor Access Control Lists API
Armor Account API
Armor Account Primary Billing API
Armor Active Response API
Armor Advanced Backup API
Armor AIP - Entity Intelligence API
Armor AIP - Incident Data API
Armor Assessments API
Armor Authentication API
Armor Cloud Connections API
Armor Connector API
Armor CSPM Connector API
Where this information came from

This is an independent, third-party profile of Armor Account Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.