Entitlements Endpoint Request and Response

Request

A Get request to the Authz1 Entitlements Endpoint looks like the following:

http://[host]:8080/v1/entitlements?subjectId=U000003

Response

The response to the above request will be:

{
    "subjectId": "U000003",
    "policies": [
        {
            "access": "grant",
            "scope": "AP000001",
            "policy": {
                "policyId": "P000002",
                "createdDate": "2022-09-09T19:18:20.101-04:00",
                "createdBy": "admin",
                "modifiedDate": "2022-09-09T19:18:20.101-04:00",
                "modifiedBy": "admin",
                "active": true
            },
            "actions": [
                {
                    "actionId": "2",
                    "name": "Bill Payment",
                    "description": "Bill Payment",
                    "createdDate": "2022-09-03T14:39:08.794-04:00",
                    "createdBy": "admin",
                    "modifiedDate": "2022-09-03T14:39:08.794-04:00",
                    "modifiedBy": "admin",
                    "active": true,
                    "enabled": true
                },
                {
                    "actionId": "4",
                    "name": "View Bill Payee",
                    "description": "View Bill Payee",
                    "createdDate": "2022-09-03T14:39:08.794-04:00",
                    "createdBy": "admin",
                    "modifiedDate": "2022-09-03T14:39:08.794-04:00",
                    "modifiedBy": "admin",
                    "active": true,
                    "enabled": true
                }
            ],
            "resources": [
                {
                    "resourceId": "A000000002",
                    "createdDate": "2022-09-09T19:16:33.557-04:00",
                    "createdBy": "admin",
                    "modifiedDate": "2022-09-09T19:16:33.557-04:00",
                    "modifiedBy": "admin",
                    "active": true,
                    "enabled": true
                }
            ]
        },
        {
            "access": "grant",
            "scope": "AP000001",
            "policy": {
                "policyId": "P000001",
                "createdDate": "2022-09-09T19:18:20.101-04:00",
                "createdBy": "admin",
                "modifiedDate": "2022-09-09T19:18:20.101-04:00",
                "modifiedBy": "admin",
                "active": true
            },
            "actions": [
                {
                    "actionId": "1",
                    "name": "Transfer",
                    "description": "Transfer",
                    "createdDate": "2022-09-03T14:39:08.794-04:00",
                    "createdBy": "admin",
                    "modifiedDate": "2022-09-03T14:39:08.794-04:00",
                    "modifiedBy": "admin",
                    "active": true,
                    "enabled": true
                }
            ],
            "resources": [
                {
                    "resourceId": "A000000001",
                    "createdDate": "2022-09-09T19:16:33.557-04:00",
                    "createdBy": "admin",
                    "modifiedDate": "2022-09-09T19:16:33.557-04:00",
                    "modifiedBy": "admin",
                    "active": true,
                    "enabled": true
                },
                {
                    "resourceId": "A000000008",
                    "createdDate": "2022-09-09T19:16:33.557-04:00",
                    "createdBy": "admin",
                    "modifiedDate": "2022-09-09T19:16:33.557-04:00",
                    "modifiedBy": "admin",
                    "active": true,
                    "enabled": true
                }
            ]
        },
        {
            "access": "grant",
            "scope": "AP000001",
            "policy": {
                "policyId": "P000003",
                "createdDate": "2022-09-09T19:18:20.101-04:00",
                "createdBy": "admin",
                "modifiedDate": "2022-09-09T19:18:20.101-04:00",
                "modifiedBy": "admin",
                "active": true
            },
            "actions": [
                {
                    "actionId": "3",
                    "name": "E-Transfer",
                    "description": "E-Transfer",
                    "createdDate": "2022-09-03T14:39:08.794-04:00",
                    "createdBy": "admin",
                    "modifiedDate": "2022-09-03T14:39:08.794-04:00",
                    "modifiedBy": "admin",
                    "active": true,
                    "enabled": true
                },
                {
                    "actionId": "5",
                    "name": "View E-Transfer Payee",
                    "description": "View E-Transfer Payee",
                    "createdDate": "2022-09-03T14:39:08.794-04:00",
                    "createdBy": "admin",
                    "modifiedDate": "2022-09-03T14:39:08.794-04:00",
                    "modifiedBy": "admin",
                    "active": true,
                    "enabled": true
                }
            ],
            "resources": [
                {
                    "resourceId": "A000000003",
                    "createdDate": "2022-09-09T19:16:33.557-04:00",
                    "createdBy": "admin",
                    "modifiedDate": "2022-09-09T19:16:33.557-04:00",
                    "modifiedBy": "admin",
                    "active": true,
                    "enabled": true
                }
            ]
        }
    ]
}

For more details on the request and response, please see
Authz1 Entitlements API OpenAPI Spec (YAML).

For the business description of this endpoint, pleas refer to the Entitlements API business documentation.