Get Token-Based Authentication Directory

Retrieves information about an authentication directory.

Request

A request to retrieve an authentication directory is described below.

HTTP Method Request URI

GET

https://api.edgecast.com/v2/mcc/customers/AccountNumber/token/directories/TBADirectoryID

Define the following variables when submitting the above request.

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3). Description

AccountNumber

Required

Replace this variable with a customer account number. This account number may be found in the upper right-hand corner of the MCC.

TBADirectoryID

Required

Replace this variable with the unique system-defined ID associated with an authentication directory.

Use the Get All Token-Based Authentication Directories endpoint to retrieve a list of directories and IDs.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameters:

Name Data Type Description

Id

Integer

Indicates the unique ID assigned to an authentication directory.

Directory

String

Indicates the relative path to an authentication directory.

MediaTypeId

Integer

Indicates an authentication directory's platform.

Valid values are:

  • 3: HTTP Large
  • 8: HTTP Small
  • 14: Application Delivery Network (ADN)

Errors

The response body for an unsuccessful request may contain an error parameter that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is provided below.

GET https://api.edgecast.com/v2/mcc/customers/0001/token/directories/123 HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Host:api.edgecast.com

A sample JSON response is provided below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 88

{
	"Id" : 123,
	"Directory" : "\/MyCustomerOrigin\/Presentations",
	"MediaTypeId" : 3
}

Sample Request and Response (XML)

A sample XML request is provided below.

GET https://api.edgecast.com/v2/mcc/customers/0001/token/directories/123 HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/xml

Host:api.edgecast.com

A sample XML response is provided below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/xml; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 313

<CustomerTokenDirectoriesAPIGetDirectoriesResult xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Id>123</Id>
	<Directory>/MyCustomerOrigin/Presentations</Directory>
	<MediaTypeId>3</MediaTypeId>
</CustomerTokenDirectoriesAPIGetDirectoriesResult>