SaaS Registration API Resources

API Summary

Operation Method Endpoint
Application
List Applications GET /config-saas-registration/v1/applications/{?contractId}
Create a New Application POST /config-saas-registration/v1/applications/{?contractId}
Get an Application GET /config-saas-registration/v1/applications/{surrogateId}/{?contractId}
Remove an Application DELETE /config-saas-registration/v1/applications/{surrogateId}/{?contractId}
Modify an Application PUT /config-saas-registration/v1/applications/{surrogateId}/{?contractId}
Customers
List Customers GET /config-saas-registration/v1/customers/{?contractId}
Create a New Customer POST /config-saas-registration/v1/customers/{?contractId}
Get a Customer GET /config-saas-registration/v1/customers/{surrogateId}/{?contractId}
Remove a Customer DELETE /config-saas-registration/v1/customers/{surrogateId}/{?contractId}
Modify a Customer PUT /config-saas-registration/v1/customers/{surrogateId}/{?contractId}
Pairs
List Pairs GET /config-saas-registration/v1/pairs/{?contractId}
Create a New Pair POST /config-saas-registration/v1/pairs/{?contractId}
Get a Pair GET /config-saas-registration/v1/pairs/{surrogateId}/{?contractId}
Remove a Pair DELETE /config-saas-registration/v1/pairs/{surrogateId}/{?contractId}
Modify a Pair PUT /config-saas-registration/v1/pairs/{surrogateId}/{?contractId}

List Applications

List all Applications associated with a given SaaS-provider-customer contract.

GET /config-saas-registration/v1/applications/{?contractId}

Example: /config-saas-registration/v1/applications/?contractId=A–1234

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234

Status 200 application/json

Response:

[
    {
        "providerApplicationId": "appId1",
        "applicationName": "Example application",
        "surrogateId": "123"
    }
]

Create a New Application

Creates a new application and returns its location.

POST /config-saas-registration/v1/applications/{?contractId}

Example: /config-saas-registration/v1/applications/?contractId=A–1234

Content-Type: application/x-www-form-urlencoded

Request:

providerApplicationId=appId1&applicationName=applicationPrettyName

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234

Status 201

Headers:

  • Location: https://CONSUMERID.luna.akamaiapis.net/config-saas-registration/v1/applications/123

URL-encoded form parameters:

Parameter Type Description
Required
applicationId String such as appId1. Deprecated. Use providerApplicationId instead. If both are specified, providerApplicationId is used.
providerApplicationId String such as appId1
Optional
applicationName String such as Example application

Get an Application

Retrieve a specific application.

GET /config-saas-registration/v1/applications/{surrogateId}/{?contractId}

Example: /config-saas-registration/v1/applications/123/?contractId=A–1234

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234
surrogateId Integer 123 such as 123

Status 200 application/json

Response:

{
    "providerApplicationId": "appId1",
    "applicationName": "Example application",
    "surrogateId": "123"
}

Remove an Application

Delete a specific application.

DELETE /config-saas-registration/v1/applications/{surrogateId}/{?contractId}

Example: /config-saas-registration/v1/applications/123/?contractId=A–1234

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234
surrogateId Integer 123 such as 123

Status 204

Modify an Application

Updates an application and returns its location.

PUT /config-saas-registration/v1/applications/{surrogateId}/{?contractId}

Example: /config-saas-registration/v1/applications/123/?contractId=A–1234

Content-Type: application/x-www-form-urlencoded

Request:

providerApplicationId=appId1&applicationName=applicationPrettyName

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234
surrogateId Integer 123 such as 123

Status 204

Headers:

  • Location: https://CONSUMERID.luna.akamaiapis.net/config-saas-registration/v1/applications/123

URL-encoded form parameters:

Parameter Type Description
Required
applicationId String such as appId1. Deprecated. Use providerApplicationId instead. If both are specified, providerApplicationId is used.
providerApplicationId String such as appId1
Optional
applicationName String such as Example application

List Customers

List all Customers associated with a given SaaS-provider-customer contract.

GET /config-saas-registration/v1/customers/{?contractId}

Example: /config-saas-registration/v1/customers/?contractId=A–1234

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234

Status 200 application/json

Response:

[
    {
        "providerCustomerId": "custId1",
        "customerName": "Example customer",
        "surrogateId": "456"
    }
]

Create a New Customer

Creates a new customer and returns its location.

POST /config-saas-registration/v1/customers/{?contractId}

Example: /config-saas-registration/v1/customers/?contractId=A–1234

Content-Type: customer/x-www-form-urlencoded

Request:

providerCustomerId=custId1&customerName=customerPrettyName

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234

Status 201

Headers:

  • Location: https://CONSUMERID.luna.akamaiapis.net/config-saas-registration/v1/customers/456

URL-encoded form parameters:

Parameter Type Description
Required
providerCustomerId String such as custId1
customerId String such as custId1. Deprecated. Use providerCustomerId instead. If both are specified, providerCustomerId is used.
Optional
customerName String such as Example customer

Get a Customer

Retrieve a specific customer.

GET /config-saas-registration/v1/customers/{surrogateId}/{?contractId}

Example: /config-saas-registration/v1/customers/456/?contractId=A–1234

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234
surrogateId Integer 456 such as 456

Status 200 application/json

Response:

{
    "providerCustomerId": "custId1",
    "customerName": "Example customer",
    "surrogateId": "456"
}

Remove a Customer

Delete a specific customer.

DELETE /config-saas-registration/v1/customers/{surrogateId}/{?contractId}

Example: /config-saas-registration/v1/customers/456/?contractId=A–1234

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234
surrogateId Integer 456 such as 456

Status 204

Modify a Customer

Updates a customer and returns its location.

PUT /config-saas-registration/v1/customers/{surrogateId}/{?contractId}

Example: /config-saas-registration/v1/customers/456/?contractId=A–1234

Content-Type: customer/x-www-form-urlencoded

Request:

providerCustomerId=custId1&customerName=customerPrettyName

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234
surrogateId Integer 456 such as 456

Status 204

Headers:

  • Location: https://CONSUMERID.luna.akamaiapis.net/config-saas-registration/v1/customers/456

URL-encoded form parameters:

Parameter Type Description
Required
customerId String such as custId1. Deprecated. Use providerCustomerId instead. If both are specified, providerCustomerId is used.
providerCustomerId String such as custId1
Optional
customerName String such as Example customer

List Pairs

List all Pairs associated with a given SaaS-provider-customer contract.

GET /config-saas-registration/v1/pairs/{?contractId}

Example: /config-saas-registration/v1/pairs/?contractId=A–1234

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234

Status 200 application/json

Response:

[
    {
        "applicationSurrogateId": 123,
        "customerSurrogateId": 456,
        "surrogateId": 789
    }
]

Create a New Pair

Creates a new pair and returns its location.

POST /config-saas-registration/v1/pairs/{?contractId}

Example: /config-saas-registration/v1/pairs/?contractId=A–1234

Content-Type: customer/x-www-form-urlencoded

Request:

customerSurrogateId=123&applicationSurrogateId=456

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234

Status 201

Headers:

  • Location: https://CONSUMERID.luna.akamaiapis.net/config-saas-registration/v1/pairs/789

URL-encoded form parameters:

Parameter Type Description
Required
customerSurrogateId Number Integer such as 123
applicationSurrogateId Number Integer such as 456

Get a Pair

Retrieve a specific pair.

GET /config-saas-registration/v1/pairs/{surrogateId}/{?contractId}

Example: /config-saas-registration/v1/pairs/123/?contractId=A–1234

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234
surrogateId Integer 123 such as 123

Status 200 application/json

Response:

{
    "applicationSurrogateId": 123,
    "customerSurrogateId": 456,
    "surrogateId": 789
}

Remove a Pair

Delete a specific pair.

DELETE /config-saas-registration/v1/pairs/{surrogateId}/{?contractId}

Example: /config-saas-registration/v1/pairs/123/?contractId=A–1234

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234
surrogateId Integer 123 such as 123

Status 204

Modify a Pair

Updates a customer and returns its location.

PUT /config-saas-registration/v1/pairs/{surrogateId}/{?contractId}

Example: /config-saas-registration/v1/pairs/123/?contractId=A–1234

Content-Type: customer/x-www-form-urlencoded

Request:

customerSurrogateId=123&applicationSurrogateId=456

Parameter Type Sample Description
Required
contractId String A-1234 such as A-1234
surrogateId Integer 123 such as 123

Status 204

Headers:

  • Location: https://CONSUMERID.luna.akamaiapis.net/config-saas-registration/v1/pairs/789

URL-encoded form parameters:

Parameter Type Description
Required
customerSurrogateId Number Integer such as 123
applicationSurrogateId Number Integer such as 456

Last modified: 12/12/2016