REST Resource: networks.daiAuthenticationKeys

Resource: DaiAuthenticationKey

A DaiAuthenticationKey is used to authenticate stream requests to the IMA SDK API.

JSON representation 
{
  "name": string,
  "status": enum (DaiAuthenticationKeyStatus),
  "displayName": string,
  "keyType": enum (DaiAuthenticationKeyType)
}
Fields
name

string

Identifier. The resource name of the DaiAuthenticationKey. Format: networks/{networkCode}/daiAuthenticationKeys/{daiAuthenticationKey}
status

enum (DaiAuthenticationKeyStatus)

Output only. The status of this DaiAuthenticationKey.

DAI authentication keys are created in the ACTIVE state.

Only active keys will be accepted by the IMA SDK API as valid.
displayName

string

Required. The name for this DaiAuthenticationKey.
keyType

enum (DaiAuthenticationKeyType)

Optional. The type of this key, which determines how it should be used on stream create requests.

DaiAuthenticationKeyStatus

Statuses associated with DaiAuthenticationKey objects.

Enums
DAI_AUTHENTICATION_KEY_STATUS_UNSPECIFIED Default value. This value is unused.
ACTIVE Indicates that the API key is actively in use and that the IMA SDK API should accept it as a valid key in requests.
INACTIVE Indicates that the API key is no longer is use and that the IMA SDK API should not accept it as a valid key in requests.

DaiAuthenticationKeyType

Key types associated with DaiAuthenticationKey objects.

Enums
DAI_AUTHENTICATION_KEY_TYPE_UNSPECIFIED Default value. This value is unused.
API Indicates that the key is a standard API key and should be used with the api-key SDK parameter when authenticating stream create requests.
HMAC Indicates that the key is an HMAC key and should be used to generate a signature for the stream create request with the auth-token SDK parameter.

Methods

batchActivate

 Activates a list of DaiAuthenticationKey objects.

batchCreate

 Batch creates DaiAuthenticationKey objects.

batchDeactivate

 Deactivates a list of DaiAuthenticationKey objects.

batchUpdate

 Batch updates DaiAuthenticationKey objects.

create

 Creates a DaiAuthenticationKey object.

get

 Retrieves a DaiAuthenticationKey object.

list

 Lists DaiAuthenticationKey objects.

patch

 Updates a DaiAuthenticationKey object.