Users Resource¶

Last updated: January 20, 2023

Note: This documentation covers the "users: resource only, which allows batch creation of users for an account. See User Resource to create, update, or deactivate a single user; or list all users in an account.

Users¶

/admin/account/users

Batch create users in an account.

Users requests¶

http method	path	description	role required
POST	/admin/account/{account_id}/users	Batch create users in an account.	admin

Headers¶

key	value	description
Authorization	Bearer {{token}}	Authentication method for ARD API requests.
Content-Type	application/json	Applies to POST, PATCH, PUT requests, which require a JSON body.

Batch create users¶

Create multiple users for an account in one request. Note that the endpoint is users in this case instead of user.

Path parameters¶

param	description	example
account_id	The ID for the account where the credentials will be registered.	557471230760500000

POST /admin/account/{account_id}/users

Role: Admin

Request Body¶

The request body for a batch user creation request includes the same fields as the single user request. The format looks like this:

Example:

{
    "users": [
        {
            "name": "Cole Hooper",
            "email": "cole@myemail.com",
            "country_code": "GBR",
            "job_title": "senior data scientist",
            "admin": true
        },
        {
            "name": "Pat Brown",
            "email": "pat@myemail.com",
            "country_code": "GBR",
            "job_title": "technical lead",
            "admin": false
        }
    ],
    "limits": {
        "annual_subscription_fee_limit": 1000,
        "fresh_imagery_fee_limit": 100,
        "standard_imagery_fee_limit": 300,
        "training_imagery_fee_limit": 600,
        "tasking_imagery_fee_limit": 0
    }
}

In this example, the "limits" values are applied to each of the users in the list.

Response¶

{
    "users": [
        {
            "account_id": "557471230760500000",
            "name": "Cole Hooper",
            "active": true,
            "admin": true,
            "super_admin": false,
            "created": "2021-07-15T19:30:27Z",
            "modified": "2021-07-15T19:30:29Z",
            "user_id": "a91db22b-ebb3-41ac-8826-5d5989e439c9",
            "country_code": "GBR",
            "job_title": "senior data scientist",
            "email": "cole@myemail.com",
            "limits": {
                "annual_subscription_fee_limit": 1000,
                "fresh_imagery_fee_limit": 100,
                "standard_imagery_fee_limit": 300,
                "training_imagery_fee_limit": 600
            }
        },
        {
            "account_id": "557471230760500000",
            "name": "Pat Brown",
            "active": true,
            "admin": false,
            "super_admin": false,
            "created": "2021-07-15T19:30:29Z",
            "modified": "2021-07-15T19:30:29Z",
            "user_id": "e436a02c-a719-4338-a8b0-3786f0fac6f9",
            "country_code": "GBR",
            "job_title": "technical lead",
            "email": "pat@myemail.com",
            "limits": {
                "annual_subscription_fee_limit": 1000,
                "fresh_imagery_fee_limit": 100,
                "standard_imagery_fee_limit": 300,
                "training_imagery_fee_limit": 600,
                "tasking_imagery_fee_limit": 0
            }
        }
    ],
    "response_timestamp": "2021-07-15T19:30:27Z"
}

Response fields¶

field	description	example
account_id	The ID for the account where the user was created.	"account_id": "557471230760500000"
name	The user's full name.	"name": "Shea Mullins"
active	The user's active/inactive status. A value of "true" means the user is active and has access to ARD resources. A value of "false" means the user record has been deactivated.	"active": true
annual_subscription_fee_limit	The total imagery fee limit set for the user. If no limit is submitted, the account limits apply.	"annual_subscription_fee_limit": 900.0
country_code	The ISO-3166-1-alpha-3 three-character country code where the user resides.	country_code": "USA"
created	The date the user record was created.	"created": "2021-07-15T18:06:53Z"
fresh_imagery_fee_limit	The fresh imagery fee limit set for the user. If no limit is set, the account's limit applies.	"standard_imagery_fee_limit": null
job title	The user's job title.	job_title": "data scientist"
modified	The date the user record was last modified with an update request.	"modified": "2021-07-18T18:06:53Z"
response_timestamp	Indicates the time the response to the request was returned.	"response_timestamp": "2021-07-15T18:06:54Z
standard_imagery_fee_limit	The standard imagery fee limit set for the user. If no limit is set, the account's limit applies.	"standard_imagery_fee_limit": null
training_imagery_fee_limit	The training imagery fee limit set for the user. If no limit is set, the account's limit applies.	"training_imagery_fee_limit": null
user_id	The ID assigned to the user.	"user_id": "25af94cf-b031-47e1-a342-d65>>>"

Links¶

link	description
self	URL to a "get self" request.
account	URL to account details.