Prerequisites for managing access roles using Cloudera Data Engineering API

Configure cdpcurl and retrieve the required use, group, and resource role CRNs before managing access roles for Cloudera Data Engineering Service or Virtual Cluster using the Cloudera Data Engineering API.

Ensure that cdpcurl is fully configured and authenticated against your environment before you run any commands. For more information, see cdpcurl.

Retrieve the list of all new role names and their Cloudera Resource Names (CRNs).

cdpcurl -X POST -d '{"pageSize": 100}' https://[***CDP_ENDPOINT***]/dex/api/v1/resource-roles --access_key [***ACCESS-KEY***] --private_key [***PRIVATE-KEY***]

Example:

cdpcurl -X POST -d '{"pageSize": 100}' https://console-cdp.apps.ecs-example.vpc.cloudera.com/dex/api/v1/resource-roles --access_key 2349bee7-3b8b-474f-ad61-7d78f7c206a9 --private_key vX2M8S4ZWlELiBjgu+vETtWxx40eS1xzaIVe6gIblS8=

Sample response:

[
    {
        "roleName": "DEAdmin",
        "roleCrn": "crn:altus:iam:us-west-1:altus:resourceRole:DEAdmin"
    },
    {
        "roleName": "DEServiceAdmin",
        "roleCrn": "crn:altus:iam:us-west-1:altus:resourceRole:DEServiceAdmin"
    },
    {
        "roleName": "DEServiceUser",
        "roleCrn": "crn:altus:iam:us-west-1:altus:resourceRole:DEServiceUser"
    },
    {
        "roleName": "DEUser",
        "roleCrn": "crn:altus:iam:us-west-1:altus:resourceRole:DEUser"
    },
    {
        "roleName": "DEVirtualClusterAdmin",
        "roleCrn": "crn:altus:iam:us-west-1:altus:resourceRole:DEVirtualClusterAdmin"
    },
    {
        "roleName": "DEVirtualClusterUser",
        "roleCrn": "crn:altus:iam:us-west-1:altus:resourceRole:DEVirtualClusterUser"
    },
    {
        "roleName": "DEVirtualClusterViewer",
        "roleCrn": "crn:altus:iam:us-west-1:altus:resourceRole:DEVirtualClusterViewer"
    }
]

Retrieve the list of users and their CRNs.

cdpcurl -X POST -d '{"pageSize": 100}' https://[***CDP_ENDPOINT***]/dex/api/v1/users --access_key [***ACCESS-KEY***] --private_key [***PRIVATE-KEY***]

Sample response:

{
    "users": [
        {
            "userId": "1f8ef572-736d-45a0-8e9c-a01c0e4ce07a",
            "crn": "crn:altus:iam:us-west-1:bc9b45e9-e962-49b9-9c81-58a40723a3a2:user:1f8ef572-736d-45a0-8e9c-a01c0e4ce07a",
            "email": "cdpuser1@cloudera.com",
            "workloadUsername": "cdpuser1"
        }
    ]
}

Retrieve the list of user groups and their CRNs.

cdpcurl -X POST -d '{"pageSize": 100}' https://[***CDP_ENDPOINT***]/dex/api/v1/groups --access_key [***ACCESS-KEY***] --private_key [***PRIVATE-KEY***]

Sample response:

{
    "groups": [
        {
            "groupName": "cdpcp",
            "crn": "crn:altus:iam:us-west-1:ffda6892-932a-4662-a6b4-693cb6a08986:group:cdpcp/ffbcef06-1abb-4388-a036-d5ce13344ac1"
        }
    ]
}