

Administration API

The page explains how to deploy the Administration API and try out the flow.

Sign in to the API Publisher portal at https:// <APIM_HOST>:9443/publisher with creator/publisher privileges.
In the homepage, go to REST API and select Import Open API.
Select OpenAPI File/Archive.
Click Browse File to Upload and select the <APIM_HOME>/<OB_APIM_TOOLKIT_HOME>/repository/resources/apis/consumerdatastandards.org.au/CDSAdminAPIs/1.24.0/consumer-data-standards-admin-1.24.0.yaml file.
Click Next.
Click Create to create the API
After the API is successfully created, go to Portal Configurations using the left menu panel.
Select Subscriptions from the left menu pane and set the business plan to Unlimited: Allows unlimited requests.
Click Save.
Go to Develop -> API Configurations -> Policies in the left menu pane to add a custom policy.
On the Policy List card, click on Add New Policy.
Fill in the Create New Policy.
Upload the <APIM_HOME>/<OB_APIM_TOOLKIT_HOME>/repository/resources/apis/consumerdatastandards.org.au/CDSAdminAPIs/1.24.0/cds-admin-api-insequence-1.24.0.xml file.
Scroll down and click Save. Upon successful creation of the policy, you receive an alert as shown below:
Expand the API endpoint you want from the list of API endpoints. For example:
Expand the HTTP method from the API endpoint you selected. For example:
Drag and drop the previously created policy to the Request Flow of the API endpoint.
Select Apply to all resources and click Save.
Scroll down and click Save.
Use the left menu panel and go to API Configurations > Endpoints.
Add a Dynamic Endpoint.
Go to Deployments using the left menu pane.
Select the API Gateway type
Click Deploy.
Go to Overview using the left menu pane.
Click Publish.

Invoke Admin API¶

Get Metrics¶

GET /admin/metrics

This endpoint allows the Australian Competition & Consumer Commission to obtain operational statistics from the Data Holder on the operation of their CDR compliant implementation. The statistics obtainable from this endpoint are determined by the non-functional requirements for the CDR regime.

Request

curl -k -X GET "https://<APIM_HOST>:8243/cds-au/v1/admin/metrics?period=ALL" -H "accept: application/json" -H "x-v: 1" -H "Authorization: Bearer <USER_ACCESS_TOKEN> "

Response

{
  "data": {
    "requestTime": "string",
    "availability": {
      "currentMonth": 0,
      "previousMonths": [
        0
      ]
    },
    "performance": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "invocations": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "lowPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "largePayload": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "secondary": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "largeSecondary": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "lowPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "largePayload": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "secondary": {
        "primary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "secondary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        }
      },
      "largeSecondary": {
        "primary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        },
        "secondary": {
          "currentDay": 0,
          "previousDays": [
            0
          ]
        }
      }
    },
    "sessionCount": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "averageTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "peakTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "errors": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "rejections": {
      "authenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "customerCount": 0,
    "recipientCount": 0,
    "secondaryHolder": {
      "errors": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "rejections": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    }
  },
  "links": {
    "self": "string"
  },
  "meta": {}
}

Tip

For more details on the response payload, see Consumer Data Standards - Get Metrics.

Metadata Update¶

POST /admin/register/metadata

The CDR Register invokes this endpoint to update the Data Holders regarding critical updates of the Accredited Data Recipients' metadata.

If the Data Holder supports Private Key JWT client authentication to authenticate the CDR Register, authorisation requires the following scope: admin:metadata:update. Otherwise, the scope is not applicable when the Data Holder supports Self-Signed JWT client authentication to authenticate the CDR Register.

Note

This operation may only be called by the CDR Register.

Top