Chilkat Online Tools

PureBasic / Anypoint Platform APIs / Invite users

Back to Collection Items

IncludeFile "CkJsonArray.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkJsonObject.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

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

    ; The following JSON is sent in the request body.

    ; [
    ;   {
    ;     "email": "amir.khan@embrace-devops.com",
    ;     "role_groups": [
    ;       {
    ;         "role_group_id": "e6263c45-738d-4e33-8286-f28b6d3e6f7c",
    ;         "name": "API Versions Owner"
    ;       }
    ;     ]
    ;   }
    ; ]

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

    CkJsonArray::ckAddObjectAt(jarr,-1)
    jsonObj_1.i = CkJsonArray::ckObjectAt(jarr,CkJsonArray::ckSize(jarr) - 1)
    CkJsonObject::ckUpdateString(jsonObj_1,"email","amir.khan@embrace-devops.com")
    CkJsonObject::ckUpdateString(jsonObj_1,"role_groups[0].role_group_id","e6263c45-738d-4e33-8286-f28b6d3e6f7c")
    CkJsonObject::ckUpdateString(jsonObj_1,"role_groups[0].name","API Versions Owner")
    CkJsonObject::ckDispose(jsonObj_1)

    ; Adds the "Authorization: Bearer {{token}}" header.
    CkHttp::setCkAuthToken(http, "{{token}}")

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

    CkJsonArray::ckEmitSb(jarr,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"POST","https://domain.com/accounts/api/organizations/{{organization_id}}/invites",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonArray::ckDispose(jarr)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

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



    CkHttp::ckDispose(http)
    CkJsonArray::ckDispose(jarr)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer {{token}}"
	-d '[
    {
        "email":"amir.khan@embrace-devops.com",
        "role_groups":
        [
            {
                "role_group_id":"e6263c45-738d-4e33-8286-f28b6d3e6f7c",
                "name":"API Versions Owner"
            }
        ]
    }
]'
https://domain.com/accounts/api/organizations/{{organization_id}}/invites

Postman Collection Item JSON

{
  "name": "Invite users",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "[\r\n    {\r\n        \"email\":\"amir.khan@embrace-devops.com\",\r\n        \"role_groups\":\r\n        [\r\n            {\r\n                \"role_group_id\":\"e6263c45-738d-4e33-8286-f28b6d3e6f7c\",\r\n                \"name\":\"API Versions Owner\"\r\n            }\r\n        ]\r\n    }\r\n]",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{url}}/accounts/api/organizations/{{organization_id}}/invites",
      "host": [
        "{{url}}"
      ],
      "path": [
        "accounts",
        "api",
        "organizations",
        "{{organization_id}}",
        "invites"
      ]
    }
  },
  "response": [
  ]
}