Ruby

Okta Client Credentials FLow

See more Okta OAuth/OIDC Examples

The Client Credentials flow is recommended for use in machine-to-machine authentication. Your application will need to securely store its Client ID and Secret and pass those to Okta in exchange for an access token. At a high-level, the flow only has two steps:

• Your application passes its client credentials to your Okta authorization server.
• If the credentials are accurate, Okta responds with an access token.

Note: This example uses "customScope". You'll replace it with whatever scope(s) you've defined for your app. Scopes are defined in your Authorization Server. See Okta Authorization Server / Scopes

Ruby

require 'chilkat'

success = false

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

http = Chilkat::CkHttp.new()

# Implements the following CURL command:

# curl --request POST \
#   --url https://{yourOktaDomain}/oauth2/default/v1/token \
#   --header 'accept: application/json' \
#   --user "client_id:client_secret" \
#   --header 'cache-control: no-cache' \
#   --header 'content-type: application/x-www-form-urlencoded' \
#   --data 'grant_type=client_credentials&scope=customScope'

http.put_Login("client_id")
http.put_Password("client_secret")

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/oauth2/default/v1/token")
req.put_ContentType("application/x-www-form-urlencoded")
req.AddParam("grant_type","client_credentials")
req.AddParam("scope","customScope")

req.AddHeader("accept","application/json")

resp = Chilkat::CkHttpResponse.new()
success = http.HttpReq("https://{yourOktaDomain}/oauth2/default/v1/token",req,resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "access_token": "eyJraWQiO ... B2CnCLj7GRUW3mQ",
#   "token_type": "Bearer",
#   "expires_in": 3600,
#   "scope": "customScope"
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

access_token = jResp.stringOf("access_token")
token_type = jResp.stringOf("token_type")
expires_in = jResp.IntOf("expires_in")
scope = jResp.stringOf("scope")