Manage Consumers

Prev Next

1. Get Consumer

This GET method returns a list of consumers.

GET
{{url}}/api/v1/policy-admin/consumers

Note: To execute this API, the user should have permission assigned (through policy) with action as authz.consumer.list.

curl -X GET '{{url}}/api/v1/policy-admin/consumers' -H 'Authorization: Bearer <token>'

Response Example 

Status: 200 Ok
{
    "result": [
        {
            "name": "ada",
            "consumerURL": null,
            "nameToIdURL": null,
            "idToNameURL": null,
            "responseType": null,
            "description": "Advanced Data Analytics"
        },
        {
            "name": "apps",
            "consumerURL": null,
            "nameToIdURL": null,
            "idToNameURL": null,
            "responseType": null,
            "description": "Applications"
        },
        {
            "name": "authz",
            "consumerURL": null,
            "nameToIdURL": null,
            "idToNameURL": null,
            "responseType": null,
            "description": "Policy Administration"
        },
        {
            "name": "diagnostics",
            "consumerURL": null,
            "nameToIdURL": null,
            "idToNameURL": null,
            "responseType": null,
            "description": "Diagnostics"
        },
        {
            "name": "identity",
            "consumerURL": null,
            "nameToIdURL": null,
            "idToNameURL": null,
            "responseType": null,
            "description": "Identity Management"
        },
        {
            "name": "notificationmanager",
            "consumerURL": null,
            "nameToIdURL": null,
            "idToNameURL": null,
            "responseType": null,
            "description": "Notification Manager"
        },
        {
            "name": "reports",
            "consumerURL": null,
            "nameToIdURL": null,
            "idToNameURL": null,
            "responseType": null,
            "description": "Reports & Dashboards"
        },
        {
            "name": "secretmanager",
            "consumerURL": "http://pod2-qa-secmgr-svc.local:8080/api/v1/secretmanager/resourceContainers?path=${resource}",
            "nameToIdURL": "http://pod2-qa-secmgr-svc.local:8080/api/v1/secretmanager/vault/secrets?path=${name}",
            "idToNameURL": "http://pod2-qa-secmgr-svc.local:8080/api/v1/secretmanager/vault/secrets/${id}",
            "responseType": "entity-based",
            "description": "Secret Manager"
        },
        {
            "name": "securityadmin",
            "consumerURL": null,
            "nameToIdURL": null,
            "idToNameURL": null,
            "responseType": null,
            "description": "Security Administration"
        },
        {
            "name": "workflows",
            "consumerURL": null,
            "nameToIdURL": null,
            "idToNameURL": null,
            "responseType": null,
            "description": "Workflows & Notifications"
        }
    ]
}