Swift

Refresh a Dynamics CRM OAuth2 Access Token

See more OAuth2 Examples

Demonstrates how to refresh an expiring Dynamics CRM access token using the refresh token. endpoint.

(If a REST API call fails with a 401 unauthorized error, an application can auto-recover by refreshing the access token, and then re-send the request using the new token.)

Swift

func chilkatTest() {
    var success: Bool = false

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

    // We previously obtained an access token and saved the JSON to a file using this example:
    // Get Dynamics CRM OAuth2 Access Token

    // This example will examine the JSON and expiration date, and if near expiration will
    // refresh the access token.

    let json = CkoJsonObject()!
    success = json.loadFile(path: "qa_data/tokens/dynamicsCrm.json")
    if success != true {
        return
    }

    // The contents of the JSON look like this:
    // {
    //   "token_type": "Bearer",
    //   "scope": "user_impersonation",
    //   "expires_in": "3599",
    //   "ext_expires_in": "0",
    //   "expires_on": "1524783438",
    //   "not_before": "1524779538",
    //   "resource": "https://mydomain.api.crm.dynamics.com",
    //   "access_token": "...",
    //   "refresh_token": "...",
    //   "id_token": "..."
    // }

    // The "expires_on" value is a Unix time.
    let dtExpire = CkoDateTime()!
    dtExpire.set(fromUnixTime: false, t: json.int(of: "expires_on").intValue)

    // If this date/time expires within 10 minutes of the current system time, refresh the token.

    // OK, we need to refresh the access token by sending a POST...
    // 

    let req = CkoHttpRequest()!
    req.addParam(name: "grant_type", value: "refresh_token")
    req.addParam(name: "redirect_uri", value: "http://localhost:3017/")
    req.addParam(name: "client_id", value: "DYNAMICS-CRM-CLIENT-ID")
    req.addParam(name: "client_secret", value: "DYNAMICS-CRM-SECRET-KEY")
    req.addParam(name: "refresh_token", value: json.string(of: "refresh_token"))
    req.addParam(name: "resource", value: "https://mydynamicsdomain.api.crm.dynamics.com")

    let http = CkoHttp()!

    req.httpVerb = "POST"
    req.contentType = "application/x-www-form-urlencoded"

    let resp = CkoHttpResponse()!
    success = http.httpReq(url: "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token", request: req, response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    // Load the JSON response.
    json.load(json: resp.bodyStr)
    json.emitCompact = false

    // Show the JSON response.
    print("\(json.emit()!)")

    print("Response status code: \(resp.statusCode.intValue)")

    // If the response status code is not 200, then it's an error.
    if resp.statusCode.intValue != 200 {
        return
    }

    // If an "expires_on" member does not exist, then add the JSON member by
    // getting the current system date/time and adding the "expires_in" seconds.
    // This way we'll know when the token expires.
    if json.hasMember(jsonPath: "expires_on") != true {
        dtExpire.setFromCurrentSystemTime()
        dtExpire.addSeconds(numSeconds: json.int(of: "expires_in").intValue)
        json.appendString(name: "expires_on", value: dtExpire.get(asUnixTimeStr: false))
    }

    // Save the refreshed access token JSON to a file for future requests.
    let fac = CkoFileAccess()!
    fac.writeEntireTextFile(path: "qa_data/tokens/dynamicsCrm.json", fileData: json.emit(), charset: "utf-8", includePreamble: false)

}