Get Subscription for Subscriber

Use this endpoint to view subscription connections based on the subscriber

URL

https://api.digitalvault.cloud/subscriptionconnection?subscriber={{subscriber}}

Method

GET

Required IMS Scopes

subscription_write

URL Parameters

Name Description
subscriber Subscriber to list connections for

Request Header Parameters

Property Description
Authentication Bearer {access_token}
required
Retrieve access token

Response Body Parameters

Reponse will be a list of the following:

Name Description
id For the connection object
subscriber Principal to list as subscriber in prefixed-principal notation
Connection JObject representing the connection to send notification to

Errors

Error Description
401 Unauthorized
403 Forbiden. Possible causes:
You do not have access to this endpoint (scope)
You do not have access to this connection

Example

Request

GET https://api.digitalvault.cloud/subscriptionconnection?subscriber=sub:app:testApp1

Response

{
    "id": "platform_assigned_id",
    "subscriber": "sub:app:testApp1",
    "connection":
    {
        "type": "AzureEventHubSend",
        "config":
        {
            "connectionString": "azure_eventhub_sendpolicy_connection_string"
        }
    }
}

Notes

  • Subscriber should be defined using the following formats:
    • User = ‘sub:user:{{USERID}}’
    • Application: ‘sub:app:{{APPID}}’