Create External ID

`POST /targets/actions/newextid`

Create a unique string that ThingSpace will pass to AWS for increased security. After creating an external identifier, you must add it to the IAM role in AWS and to the corresponding target in ThingSpace.

See also:
Create a target
Streaming to AWS

Uses and Requirements

An external ID is only required to stream data to an AWS account. It is not required for streaming to non-AWS targets.

You can create different external IDs if you are using multiple targets to stream to AWS, or you can use the same external ID with all AWS roles and targets.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/cc/v1/targets/actions/newextid

Resource Path and Query Parameters

None.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token, and must set the content-type to JSON.

Property Name	Data Type	Description
Authorization required	string	HTTP Authorization request header containing a valid ThingSpace Bearer token.
VZ-M2M-Token required	string	A valid session token returned by a Connectivity Management API POST /session/login request using the account’s UWS credentials.
Content-Type required	string	Must be `application/json`.

Request Body

The request body only contains the authenticating account.

Property Name	Data Type	Description
accountidentifier required	JSON object	The ID of the authenticating billing account, in the format `{"billingaccountid":"1234567890-12345"}`.

Example Request

curl -X POST \
  https://thingspace.verizon.com/api/cc/v1/targets/actions/newextid \
  -H 'Authorization: Bearer 225aec324bb619d10101ca905fd2479e' \
  -H 'VZ-M2M-Token: 85d73f80-3127-4d04-81ae-82497cc557dd' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountidentifier": {"billingaccountid":"1223334444-00001"}
}'

Success Responses

Status 200

A successful response contains a new external ID.

Property Name	Data Type	Description
externalid	string	Newly created security string

Example Success Response

{
  "externalid": "ZlJnih8BfqsosZrEEkfPuR3aGOk2i-HIr6tXN275ioJF6bezIrQB9EbzpTRep8J7RmV7QH=="}
}

Failure Responses

Status 4xx

All error messages are returned in this format:

{
  "error": "error code string",
  "error_description": "error message string",
  "cause": "further explanation"
}

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.