(PureBasic) Amazon Cognito - List Users

See more Amazon Cognito Examples

Lists the users in the Amazon Cognito user pool.

For more information, see https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUsers.html

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkAuthAws.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
    ; Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
    CkAuthAws::setCkRegion(authAws, "us-west-2")
    CkAuthAws::setCkServiceName(authAws, "cognito-idp")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://cognito-idp.us-west-2.amazonaws.com/
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"cognito-idp.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)
    If success <> 1
        Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    ; Note: The above code does not need to be repeatedly called for each REST request.
    ; The rest object can be setup once, and then many requests can be sent.  Chilkat will automatically
    ; reconnect within a FullRequest* method as needed.  It is only the very first connection that is explicitly
    ; made via the Connect method.

    ; The following JSON is sent in the request body.

    ; {
    ;     "UserPoolId": "us-west-2_yt6WzO3SA"
    ; }
    ; 

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"UserPoolId","us-west-2_yt6WzO3SA")

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.0")
    CkRest::ckAddHeader(rest,"X-Amz-Target","AWSCognitoIdentityProviderService.ListUsers")
    CkRest::ckAddHeader(rest,"Accept-Encoding","identity")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    respStatusCode.i = CkRest::ckResponseStatusCode(rest)
    Debug "response status code = " + Str(respStatusCode)
    If respStatusCode <> 200
        Debug "Response Status Code = " + Str(respStatusCode)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug "Response Body:"
        Debug CkStringBuilder::ckGetAsString(sbResponseBody)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jsonResponse.i = CkJsonObject::ckCreate()
    If jsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody)

    CkJsonObject::setCkEmitCompact(jsonResponse, 0)
    Debug CkJsonObject::ckEmit(jsonResponse)

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; Use this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    ; {
    ;   "Users": [
    ;     {
    ;       "Attributes": [
    ;         {
    ;           "Name": "sub",
    ;           "Value": "1874cf28-00d3-4ac1-a24a-68dcb0cecf09"
    ;         },
    ;         {
    ;           "Name": "email_verified",
    ;           "Value": "true"
    ;         },
    ;         {
    ;           "Name": "phone_number_verified",
    ;           "Value": "true"
    ;         },
    ;         {
    ;           "Name": "phone_number",
    ;           "Value": "+16302581871"
    ;         },
    ;         {
    ;           "Name": "email",
    ;           "Value": "admin@chilkatsoft.com"
    ;         }
    ;       ],
    ;       "Enabled": true,
    ;       "UserCreateDate": 1.636404386657E9,
    ;       "UserLastModifiedDate": 1.636404386657E9,
    ;       "UserStatus": "FORCE_CHANGE_PASSWORD",
    ;       "Username": "matt"
    ;     },
    ;     {
    ; 	. . .
    ;     }
    ;   ]
    ; }

    Enabled.i
    UserCreateDate.s
    UserLastModifiedDate.s
    UserStatus.s
    Username.s
    j.i
    count_j.i
    Name.s
    Value.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jsonResponse,"Users")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        Enabled = CkJsonObject::ckBoolOf(jsonResponse,"Users[i].Enabled")
        UserCreateDate = CkJsonObject::ckStringOf(jsonResponse,"Users[i].UserCreateDate")
        UserLastModifiedDate = CkJsonObject::ckStringOf(jsonResponse,"Users[i].UserLastModifiedDate")
        UserStatus = CkJsonObject::ckStringOf(jsonResponse,"Users[i].UserStatus")
        Username = CkJsonObject::ckStringOf(jsonResponse,"Users[i].Username")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jsonResponse,"Users[i].Attributes")
        While j < count_j
            CkJsonObject::setCkJ(jsonResponse, j)
            Name = CkJsonObject::ckStringOf(jsonResponse,"Users[i].Attributes[j].Name")
            Value = CkJsonObject::ckStringOf(jsonResponse,"Users[i].Attributes[j].Value")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure