Account

Endpoints to manage and retrieve data related to the Aerial account

Retrieve an Aerial account
Early Access
OAuth 2.0:
  • okta.accounts.read

Retrieves an Aerial account by accountId

SecurityOAuth2
Request
path Parameters
accountId
required
string

The id of the Aerial account

Responses
200

Success

401

Unauthorized

403

Forbidden

404

Resource Not Found

429

Rate limit exceeded

500

Internal Server Error

get/{accountId}/api/v1/accounts
Request samples 
Response samples 
application/json
{
  • "id": "022ha15dpfc6e884cd3xrhn4259",
  • "name": "My Account"
}
Replace an Aerial account
Early Access
OAuth 2.0: 
  • okta.accounts.manage
Replace the properties of an Aerial account


SecurityOAuth2 
Request 
path Parameters
accountId
required
string
The id of the Aerial account


 
Request Body schema: application/json
required
Replaces all fields of an Aerial account that are mutable (currently only name)


name
required
string  <= 255 characters 
The name of the Aerial account


 
Responses 
200
Success


400
Bad Request


401
Unauthorized


403
Forbidden


429
Rate limit exceeded


500
Internal Server Error


put/{accountId}/api/v1/accounts
Request samples 
application/json
{
  • "name": "My Account"
}
Response samples 
application/json
{
  • "id": "022ha15dpfc6e884cd3xrhn4259",
  • "name": "My Account"
}
List all subscribed products
Early Access
OAuth 2.0: 
  • okta.accounts.read
Lists all subscribed products


SecurityOAuth2 
Request 
path Parameters
accountId
required
string
The id of the Aerial account


 
Responses 
200
Success


400
Bad Request


401
Unauthorized


403
Forbidden


404
Resource Not Found


429
Rate limit exceeded


500
Internal Server Error


get/{accountId}/api/v1/products
Request samples 
Response samples 
application/json
[
  • {
    • "id": "P000052",
    • "name": "IT Products - SSO"
    },
  • {
    • "id": "P000131",
    • "name": "IT Products - MFA"
    },
  • {
    • "id": "P000139",
    • "name": "IT Products - Lifecycle Management with 1 OIN App"
    }
]