Chilkat Online Tools

Ruby / Salesforce Platform APIs / OpenID Connect Dynamic Client Registration Endpoint

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "redirect_uris": [
#     "http://localhost"
#   ],
#   "response_types": [
#     "code",
#     "token",
#     "id_token"
#   ],
#   "grant_types": [
#     "authorization_code",
#     "implicit",
#     "refresh_token"
#   ],
#   "application_type": "web",
#   "contacts": [
#     "abc@sf.com",
#     "ve7jtb@example.org"
#   ],
#   "client_name": "Example Olivier"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("redirect_uris[0]","http://localhost")
json.UpdateString("response_types[0]","code")
json.UpdateString("response_types[1]","token")
json.UpdateString("response_types[2]","id_token")
json.UpdateString("grant_types[0]","authorization_code")
json.UpdateString("grant_types[1]","implicit")
json.UpdateString("grant_types[2]","refresh_token")
json.UpdateString("application_type","web")
json.UpdateString("contacts[0]","abc@sf.com")
json.UpdateString("contacts[1]","ve7jtb@example.org")
json.UpdateString("client_name","Example Olivier")

http.SetRequestHeader("Content-Type","application/json")
# Adds the "Authorization: Bearer {{init_access_token}}" header.
http.put_AuthToken("{{init_access_token}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://login.salesforce.com{{site}}/services/oauth2/register","application/json",json)
if (http.get_LastMethodSuccess() == 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)

# {
#   "client_id": "<client_id>",
#   "client_secret": "<client_secret>",
#   "registration_access_token": "<token>",
#   "registration_client_uri": "https://login.salesforce.com/services/oauth2/register/<client_id>",
#   "client_id_issued_at": <timestamp>,
#   "client_secret_expires_at": 0,
#   "token_endpoint_auth_method": "client_secret_post",
#   "redirect_uris": [
#     "http://localhost"
#   ],
#   "response_types": [
#     "code",
#     "token",
#     "id_token"
#   ],
#   "grant_types": [
#     "authorization_code",
#     "hybrid_auth_code",
#     "implicit",
#     "refresh_token"
#   ],
#   "contacts": [
#     "abc@sf.com"
#   ],
#   "client_name": "Sample Customer",
#   "scopes": [
#     "openid",
#     "refresh_token",
#     "id",
#     "api"
#   ]
# }

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

client_id = jResp.stringOf("client_id")
client_secret = jResp.stringOf("client_secret")
registration_access_token = jResp.stringOf("registration_access_token")
registration_client_uri = jResp.stringOf("registration_client_uri")
client_id_issued_at = jResp.IntOf("client_id_issued_at")
client_secret_expires_at = jResp.IntOf("client_secret_expires_at")
token_endpoint_auth_method = jResp.stringOf("token_endpoint_auth_method")
client_name = jResp.stringOf("client_name")
i = 0
count_i = jResp.SizeOfArray("redirect_uris")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("redirect_uris[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("response_types")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("response_types[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("grant_types")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("grant_types[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("contacts")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("contacts[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("scopes")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("scopes[i]")
    i = i + 1
end

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{init_access_token}}"
	-d '{
    "redirect_uris": [
        "http://localhost"
    ],
    "response_types": [
        "code",
        "token",
        "id_token"
    ],
    "grant_types": [
        "authorization_code",
        "implicit",
        "refresh_token"
    ],
    "application_type": "web",
    "contacts": [
        "abc@sf.com",
        "ve7jtb@example.org"
    ],
    "client_name": "Example Olivier"
}'
https://login.salesforce.com{{site}}/services/oauth2/register

Postman Collection Item JSON

{
  "name": "OpenID Connect Dynamic Client Registration Endpoint",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      },
      {
        "key": "Accept",
        "value": "application/json",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{init_access_token}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"redirect_uris\": [\n        \"http://localhost\"\n    ],\n    \"response_types\": [\n        \"code\",\n        \"token\",\n        \"id_token\"\n    ],\n    \"grant_types\": [\n        \"authorization_code\",\n        \"implicit\",\n        \"refresh_token\"\n    ],\n    \"application_type\": \"web\",\n    \"contacts\": [\n        \"abc@sf.com\",\n        \"ve7jtb@example.org\"\n    ],\n    \"client_name\": \"Example Olivier\"\n}"
    },
    "url": {
      "raw": "{{url}}{{site}}/services/oauth2/register",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "oauth2",
        "register"
      ]
    }
  },
  "response": [
    {
      "name": "Successful OpenID Connect Dynamic Client Registration Endpoint",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "key": "Authorization",
            "value": "Bearer {{init_access_token}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"redirect_uris\": [\n        \"http://localhost\"\n    ],\n    \"response_types\": [\n        \"code\",\n        \"token\",\n        \"id_token\"\n    ],\n    \"grant_types\": [\n        \"authorization_code\",\n        \"implicit\",\n        \"refresh_token\"\n    ],\n    \"application_type\": \"web\",\n    \"contacts\": [\n        \"abc@sf.com\",\n        \"ve7jtb@example.org\"\n    ],\n    \"client_name\": \"Sample Customer\"\n}"
        },
        "url": {
          "raw": "{{url}}{{site}}/services/oauth2/register",
          "host": [
            "{{url}}{{site}}"
          ],
          "path": [
            "services",
            "oauth2",
            "register"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 16 Nov 2023 16:04:08 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"client_id\": \"<client_id>\",\n    \"client_secret\": \"<client_secret>\",\n    \"registration_access_token\": \"<token>\",\n    \"registration_client_uri\": \"https://login.salesforce.com/services/oauth2/register/<client_id>\",\n    \"client_id_issued_at\": <timestamp>,\n    \"client_secret_expires_at\": 0,\n    \"token_endpoint_auth_method\": \"client_secret_post\",\n    \"redirect_uris\": [\n        \"http://localhost\"\n    ],\n    \"response_types\": [\n        \"code\",\n        \"token\",\n        \"id_token\"\n    ],\n    \"grant_types\": [\n        \"authorization_code\",\n        \"hybrid_auth_code\",\n        \"implicit\",\n        \"refresh_token\"\n    ],\n    \"contacts\": [\n        \"abc@sf.com\"\n    ],\n    \"client_name\": \"Sample Customer\",\n    \"scopes\": [\n        \"openid\",\n        \"refresh_token\",\n        \"id\",\n        \"api\"\n    ]\n}"
    }
  ]
}