Chilkat Online Tools

PureBasic / Cognite API v1 / Retrieve a logout url

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

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

    success.i

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

    CkJsonObject::ckUpdateString(queryParams,"redirectUrl","https://mysite.com/loggedout")

    CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/logout/url",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "redirectUrl=https%3A%2F%2Fmysite.com%2Floggedout"
	-H "api-key: {{api-key}}"
https://domain.com/logout/url

Postman Collection Item JSON

{
  "id": "logoutUrl",
  "name": "Retrieve a logout url",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "logout",
        "url"
      ],
      "query": [
        {
          "key": "redirectUrl",
          "description": "The url to send the user to after the logout is successful. If no url is passed, you will end up at the IdP's log out page.",
          "value": "https://mysite.com/loggedout",
          "disabled": true
        }
      ],
      "variable": [
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ],
    "description": "Get logout url of the given project."
  }
}