Fetching List of DKE Authorized Tenants

Use the get /v1/cckm/microsoft/dke/auth-tenants API to fetch a list of the Microsoft DKE authorized tenants from CCKM. The results can be filtered using the query parameters.

Syntax

curl -k '<CCKM IP address>/v1/cckm/microsoft/dke/auth-tenants' -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed

Request Parameters

Parameter	Type	Description
AUTHTOKEN	string	Authorization token.

Request Query Parameters

Parameter	Type	Description
id	string	ID of the DKE authorized tenant.
name	string	Name of the DKE authorized tenant.
authorization_type	string	Authorization type for DKE key: `email` and `role`.
connection	string	ID of the Azure connection. Mandatory for role-based authorization.
tenant_id	string	tenant_id for the authorized tenant.
issuer	string	A valid issuer for the DKE authorized tenant. Currently, only one issuer is supported. For example, https://sts.windows.net/azure tenant ID/. This issuer must match the issuer within the JWT that the CCKM receives.
skip	integer	Number of records to skip. For example, if `"skip":5` is specified, the first five records will not be displayed in the output.
limit	integer	Numbers of records to display. For example, if `"limit":10` is specified, then the next 10 records (after skipping the number of records specified in the `skip` parameter) will be displayed in the output.
sort	string	Comma-delimited list of properties to sort the results.

Example Request

curl -k 'https://54.173.227.108/api/v1/cckm/microsoft/dke/auth-tenants?skip=0&limit=10&sort=updatedAt' -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1OGE3OTZlNi0wMjY0LTRjNjgtOWVlOS0xNTEzODFmYWYxZWIiLCJzdWIiOiJsb2NhbHwxYWIwNGY0ZC01MDQ5LTQ0M2ItOWQ0OC02MzVlYjVjNDRmYzciLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODM3Yzg0MGQtNzVkZC00YjRmLWEzMTgtNzljYjE2Y2EyNDhkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjQyZDNiZTI5LTEyZmEtNDY3ZC04OGM1LTJhNTViZTI0YmY4MyIsImlhdCI6MTcwODUwMjYwNSwiZXhwIjoxNzA4NTAyOTA1fQ.SHwA1KtE8etYp2HC4dbjAUmE6iB3tO3p-9pDYK44hyqsA12QfIvDm3B5btV91QnrA4jsUQ8dsPouMp41_2PaHA' -H 'accept: application/json' --compressed

Example Response

{
    "skip": "0,",
    "limit": "10,",
    "total": "2,",
    "resources": [
        {
            "id": "c575e91f-411d-4042-b526-b6f7e3f50f1b",
            "uri": "kylo:kylo:cckm:dke-auth-tenant:c575e91f-411d-4042-b526-b6f7e3f50f1b",
            "account": "kylo:kylo:admin:accounts:kylo",
            "createdAt": "2023-12-28T04:57:52.719716Z",
            "updatedAt": "2023-12-28T04:57:52.719244Z",
            "name": "Authorized tenent 001",
            "tenant_id": "9c99431e-b513-44be-a7d9-e7b500002dcd",
            "authorization_type": "email",
            "issuer": "https://sts.windows.net/d27d849e-e487-4b0e-a54c-a71e67687d10/",
            "authorized_email_addresses": [
                "ali@example.com"
            ]
        }
        {
            "id": "d815e91f-411d-4042-b526-b6f7e3f50i7z",
            "uri": "kylo:kylo:cckm:dke-auth-tenant:c575e91f-411d-4042-b526-b6f7e3f50f1b",
            "account": "kylo:kylo:admin:accounts:kylo",
            "createdAt": "2023-12-28T04:57:52.719716Z",
            "updatedAt": "2023-12-28T04:57:52.719244Z",
            "name": "Authorized tenent 002",
            "tenant_id": "9c99431e-b513-44be-a7d9-e7b500002dcd",
            "authorization_type": "email",
            "issuer": "https://sts.windows.net/9c99431e-b513-44be-a7d9-e7b500002dcd/",
            "authorized_email_addresses": [
                "ali@example.com"
            ]
        }
    ]
}

The sample output shows two DKE authorized tenants listed--one with the ID of c575e91f-411d-4042-b526-b6f7e3f50f1b and the other with the ID of d815e91f-411d-4042-b526-b6f7e3f50i7z.

Response Codes

Response Code	Description
2xx	Success
4xx	Client errors
5xx	Server errors

Refer to HTTP status codes for details.

Suggest A Change