@manyos/smileconnect-api 1.28.0

package/docs/howto/sample-config.md

@@ -0,0 +1,518 @@
+---
+layout: page
+title: Sample Config
+subtitle: The following config will allow you to use all our samples from the how-to guides.
+use-site-title: true
+---
+
+You need to a *client.json* and a *mapping.json* file in your /conf folder.
+
+The *client.json* file is for authorisation purposes. It lets you define to which records (row-level) and to which fields (attribute-level) a client has access.
+
+e.g. Client A should only have access to the incident that it has submitted and you only want to expose the fields id, summary and status. 
+
+Client B should have access to all incidents of support group ABC and you want to expose the fields id, summary, status, detailedDescription, assignee, resolution 
+
+The *mapping.json* files defines a global mapping of field names. 
+
+e.g. if you map the incident field *Detailed Decription* to *detailedDescription* than this mapping will be used inbound and outbound for all clients.
+
+# Username, ClientId & Company
+
+For all our expamples we assume that your clientId is *isapi* and that there is also a User in ITSM with the Remedy Login ID *isapi* that should be used to create new tickets. We also assume that you use BMCs Test-Company *Calbro Services*
+
+# clients.json
+{% highlight json linenos %}
+[
+  {
+    "name": "isapi",
+    "config": {
+      "options" : {
+        "dateFormat" : "dd.MM.yyyy HH:mm.ss"
+      },
+      "cmdbobject": {
+        "basequery": "'Data Set Id' = \"BMC.ASSET\" AND ('Mark As Deleted' = \"No\" OR 'Mark As Deleted' = $NULL$) AND 'Class Id' = \"BMC_COMPUTERSYSTEM\"",
+        "fields": [
+          "Instance Id",
+          "Tag Number",
+          "Name",
+          "AssetLifecycleStatus",
+          "Category",
+          "Item",
+          "Type",
+          "Availability",
+          "Confidentiality",
+          "Integrity",
+          "Authenticity",
+          "Model Number",
+          "Class Id",
+          "Reconciliation Identity",
+          "Short Description"
+        ]
+      },
+      "orgdata": {
+        "basequeryPeople": "'Profile Status' = \"Enabled\"",
+        "basequeryOrganisation": "'Status'=\"Enabled\"",
+        "basequerySupportGroup": "'Status'=\"Enabled\""
+      },
+      "change": {
+        "fields": [
+          "Infrastructure Change ID",
+          "Categorization Tier 1",
+          "Categorization Tier 2",
+          "Categorization Tier 3",
+          "Product Cat Tier 1",
+          "Product Cat Tier 2",
+          "Product Cat Tier 3",
+          "Product Name (2)",
+          "Description",
+          "Detailed Description",
+          "Status Reason",
+          "Change Request Status",
+          "Requested Start Date",
+          "Requested End Date",
+          "Scheduled Start Date",
+          "Scheduled End Date",
+          "Support Group ID",
+          "Support Group ID 2",
+          "Customer Person ID",
+          "Requested By Person ID"
+        ],
+        "constants" : [
+          {"name": "Location Company", "value" : "Calbro Services"},
+          {"name": "Company", "value" : "Calbro Services"},
+          {"name": "RequesterLoginID", "value" : "isapi"}
+        ]
+      },
+      "changeWorklog": {
+        "fields": [
+          "Description",
+          "Detailed Description"
+        ],
+        "constants" : [
+          {"name": "Status", "value" : "Enabled"},
+          {"name": "Work Log Type", "value" : "General Information"},
+          {"name": "Communication Source", "value" : "Other"},
+          {"name": "View Access", "value" : "Internal"}
+        ]
+      },
+      "workOrder": {
+        "fields": [
+          "Work Order ID",
+          "Status",
+          "InstanceId",
+          "WO Type Field 2",
+          "Categorization Tier 1",
+          "Categorization Tier 2",
+          "Categorization Tier 3",
+          "Product Cat Tier 1(2)",
+          "Product Cat Tier 2(2)",
+          "Product Cat Tier 3(2)",
+          "Product Name",
+          "Summary",
+          "Detailed Description",
+          "Status Reason",
+          "Scheduled Start Date",
+          "Scheduled End Date",
+          "Support Group ID",
+          "Support Group ID 2",
+          "Customer Person ID",
+          "Requested By Person ID"
+        ],
+        "constants" : [
+          {"name": "Location Company", "value" : "Calbro Services"},
+          {"name": "Company", "value" : "Calbro Services"},
+          {"name": "RequesterLoginID", "value" : "isapi"}
+        ]
+      },
+      "incident": {
+        "fields": [
+          "Incident Number",
+          "Status",
+          "WO Type Field 2",
+          "Categorization Tier 1",
+          "Categorization Tier 2",
+          "Categorization Tier 3",
+          "Product Categorization Tier 1",
+          "Product Categorization Tier 2",
+          "Product Categorization Tier 3",
+          "Product Name",
+          "Manufacturer",
+          "Detailed Decription",
+          "Description",
+          "Status Reason",
+          "Impact",
+          "Urgency",
+          "Priority",
+          "Assigned Group ID",
+          "Owner Group ID",
+          "Vendor Group ID",
+          "Person ID",
+          "Direct Contact Person ID"
+        ],
+        "constants" : [
+          {"name": "Impact", "value" : "4000"},
+          {"name": "Urgency", "value" : "4000"},
+          {"name": "Login_ID", "value" : "isapi"},
+          {"name": "Service_Type", "value" : "0"},
+          {"name": "Reported Source", "value" : "1000"},
+          {"name": "Status", "value" : "0"}
+        ]
+      },
+      "problem": {
+        "fields": [
+          "Problem Investigation ID",
+          "Status",
+          "WO Type Field 2",
+          "Categorization Tier 1",
+          "Categorization Tier 2",
+          "Categorization Tier 3",
+          "Product Categorization Tier 1",
+          "Product Categorization Tier 2",
+          "Product Categorization Tier 3",
+          "Product Name",
+          "Manufacturer",
+          "Detailed Decription",
+          "Description",
+          "Status Reason",
+          "Impact",
+          "Urgency",
+          "Priority",
+          "Assigned Group ID",
+          "Owner Group ID",
+          "Vendor Group ID",
+          "Person ID",
+          "Direct Contact Person ID"
+        ],
+        "constants" : [
+          {"name": "Impact", "value" : "4000"},
+          {"name": "Urgency", "value" : "4000"},
+          {"name": "Login_ID", "value" : "isapi"},
+          {"name": "Service_Type", "value" : "0"},
+          {"name": "Reported Source", "value" : "1000"},
+          {"name": "Status", "value" : "0"}
+        ]
+      },
+      "workOrderWorklog": {
+        "fields": [
+          "Description",
+          "Detailed Description"
+        ],
+        "constants" : [
+          {"name": "Status", "value" : "Enabled"},
+          {"name": "Work Log Type", "value" : "General Information"},
+          {"name": "Communication Source", "value" : "Other"}
+        ]
+    },
+      "incidentWorklog": {
+        "fields": [
+          "Description",
+          "Detailed Description"
+        ],
+        "constants" : [
+          {"name": "Status", "value" : "Enabled"},
+          {"name": "Work Log Type", "value" : "General Information"},
+          {"name": "Communication Source", "value" : "Other"}
+        ]
+      },
+      "problemWorklog": {
+        "fields": [
+          "Description",
+          "Detailed Description"
+        ],
+        "constants" : [
+          {"name": "Status", "value" : "Enabled"},
+          {"name": "Work Log Type", "value" : "General Information"},
+          {"name": "Communication Source", "value" : "Other"}
+        ]
+      },
+      "task": {
+        "basequery" : "1=1",
+        "fields": [
+          "Status",
+          "InstanceId",
+          "Sequence",
+          "Service Cat Tier 1",
+          "Service Cat Tier 2",
+          "Service Cat Tier 3",
+          "Product Cat Tier 1",
+          "Product Cat Tier 2",
+          "Product Cat Tier 3",
+          "Product Name",
+          "Summary",
+          "Notes",
+          "StatusReasonSelection",
+          "Scheduled Start Date",
+          "Scheduled End Date",
+          "Assignee Group ID",
+          "Customer Person ID",
+          "Requested By Person ID",
+          "Actual Start Date",
+          "Actual End Date",
+          "Character 06",
+          "Character 01",
+          "Support Company",
+          "Assignee Organization",
+          "Assignee Group"
+        ],
+        "constants" : [
+          {"name": "Location Company", "value" : "Calbro Services"},
+          {"name": "TaskType", "value" : "2000"},
+          {"name": "Status", "value" : "1000"}
+        ]
+      },
+      "taskWorklog": {
+        "constants" : [
+          {"name": "Status", "value" : "Enabled"},
+          {"name": "WorkInfoType", "value" : "General Information"},
+          {"name": "Communication Source", "value" : "Other"},
+          {"name": "View Access", "value" : "Internal"}
+        ]
+      },
+      "flowBuilder": {
+        "constants" : [
+          {"name": "Location Company", "value" : "Calbro Services"}
+        ]
+      }
+  }
+  }
+]
+{% endhighlight %}
+
+# mapping.json
+
+{% highlight json linenos %}
+{
+  "cmdbobject":[
+    {"oldName":"Instance Id", "newName" : "id"},
+    {"oldName":"Tag Number", "newName" : "tagNumber"},
+    {"oldName":"Name", "newName" : "name"},
+    {"oldName":"AssetLifecycleStatus", "newName" : "assetlifecycleStatus"},
+    {"oldName":"Category", "newName" : "category"},
+    {"oldName":"Item", "newName" : "item"},
+    {"oldName":"Type", "newName" : "type"},
+    {"oldName":"Availability", "newName" : "availability"},
+    {"oldName":"Confidentiality", "newName" : "confidentiality"},
+    {"oldName":"Integrity", "newName" : "integrity"},
+    {"oldName":"Authenticity", "newName" : "authenticity"},
+    {"oldName":"Model Number", "newName" : "productName"},
+    {"oldName":"Class Id", "newName" : "classId"},
+    {"oldName":"Reconciliation Identity", "newName" : "reconId"},
+    {"oldName":"Short Description", "newName" : "shortDescription"}
+  ],
+  "change":[
+    {"oldName":"Infrastructure Change ID", "newName" : "id"},
+    {"oldName":"Categorization Tier 1", "newName" : "opsCat1"},
+    {"oldName":"Categorization Tier 2", "newName" : "opsCat2"},
+    {"oldName":"Categorization Tier 3", "newName" : "opsCat3"},
+    {"oldName":"Product Cat Tier 1", "newName" : "prodCat1"},
+    {"oldName":"Product Cat Tier 2", "newName" : "prodCat2"},
+    {"oldName":"Product Cat Tier 3", "newName" : "prodCat3"},
+    {"oldName":"Product Name (2)", "newName" : "productName"},
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"Detailed Description", "newName" : "detailedDescription"},
+    {"oldName":"Status Reason", "newName" : "statusReason"},
+    {"oldName":"Change Request Status", "newName" : "status"},
+    {"oldName":"Requested Start Date", "newName" : "requestedStartDate"},
+    {"oldName":"Requested End Date", "newName" : "requestedEndDate"},
+    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
+    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
+    {"oldName":"Support Group ID", "newName" : "managerGroup"},
+    {"oldName":"Support Group ID 2", "newName" : "coordinatorGroup"},
+    {"oldName":"Customer Person ID", "newName" : "customerId"},
+    {"oldName":"Requested By Person ID", "newName" :  "requestorId"}
+  ],
+  "newChange":[
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"TemplateID", "newName" : "template"}
+  ],
+  "changeWorklog":[
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"Detailed Description", "newName" : "text"},
+    {"oldName":"Infrastructure Change ID", "newName" : "Infrastructure Change ID"},
+    {"oldName":"Infra. Change Entry ID", "newName" : "Infra. Change Entry ID"},
+    {"oldName":"Work Log ID", "newName" : "worklogId"}
+  ],
+  "workOrder":[
+    {"oldName":"Work Order ID", "newName" : "id"},
+    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
+    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
+    {"oldName":"Categorization Tier 1", "newName" : "opsCat1"},
+    {"oldName":"Categorization Tier 2", "newName" : "opsCat2"},
+    {"oldName":"Categorization Tier 3", "newName" : "opsCat3"},
+    {"oldName":"Product Cat Tier 1(2)", "newName" : "prodCat1"},
+    {"oldName":"Product Cat Tier 2(2)", "newName" : "prodCat2"},
+    {"oldName":"Product Cat Tier 3(2)", "newName" : "prodCat3"},
+    {"oldName":"Product Name", "newName" : "productName"},
+    {"oldName":"Summary", "newName" : "summary"},
+    {"oldName":"Detailed Description", "newName" : "detailedDescription"},
+    {"oldName":"Status Reason", "newName" : "statusReason"},
+    {"oldName":"Status", "newName" : "status"},
+    {"oldName":"Support Group ID", "newName" : "managerGroup"},
+    {"oldName":"Support Group ID 2", "newName" : "coordinatorGroup"},
+    {"oldName":"Customer Person ID", "newName" : "customerId"},
+    {"oldName":"Requested By Person ID", "newName" :  "requestorId"}
+  ],
+  "newWorkOrder":[
+    {"oldName":"Summary", "newName" : "summary"},
+    {"oldName":"TemplateID", "newName" : "template"},
+    {"oldName":"Customer Person ID", "newName" : "customerId"},
+    {"oldName":"Detailed Description", "newName" : "detailedDescription"},
+    {"oldName":"Vendor Ticket Number", "newName" : "vendorTicketId"}
+  ],
+  "workOrderWorklog":[
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"Detailed Description", "newName" : "text"},
+    {"oldName":"WorkOrder_EntryID", "newName" : "WorkOrder_EntryID"},
+    {"oldName":"Work Order ID", "newName" : "Work Order ID"},
+    {"oldName":"Work Log ID", "newName" : "worklogId"}
+  ],
+  "incidentWorklog":[
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"Detailed Description", "newName" : "text"},
+    {"oldName":"Incident Number", "newName" : "Incident Number"},
+    {"oldName":"Incident Entry ID", "newName" : "Incident Entry ID"},
+    {"oldName":"Work Log ID", "newName" : "id"}
+  ],
+  "problemWorklog":[
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"Detailed Description", "newName" : "text"},
+    {"oldName":"Problem Investigation ID", "newName" : "Problem Investigation ID"},
+    {"oldName":"Problem Investigation Entry ID", "newName" : "Problem Investigation Entry ID"},
+    {"oldName":"Work Log ID", "newName" :  "worklogId"}
+  ],
+  "incident":[
+    {"oldName":"Incident Number", "newName" : "id"},
+    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
+    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
+    {"oldName":"Categorization Tier 1", "newName" : "opsCat1"},
+    {"oldName":"Categorization Tier 2", "newName" : "opsCat2"},
+    {"oldName":"Categorization Tier 3", "newName" : "opsCat3"},
+    {"oldName":"Resolution Category", "newName" : "resolutionCat1"},
+    {"oldName":"Resolution Category Tier 2", "newName" : "resolutionCat2"},
+    {"oldName":"Resolution Category Tier 3", "newName" : "resolutionCat3"},
+    {"oldName":"Product Categorization Tier 1", "newName" : "prodCat1"},
+    {"oldName":"Product Categorization Tier 2", "newName" : "prodCat2"},
+    {"oldName":"Product Categorization Tier 3", "newName" : "prodCat3"},
+    {"oldName":"Product Name", "newName" : "productName"},
+    {"oldName":"Manufacturer", "newName" : "manufacturer"},
+    {"oldName":"Detailed Decription", "newName" : "detailedDescription"},
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"Status_Reason", "newName" : "statusReason"},
+    {"oldName":"Status", "newName" : "status"},
+    {"oldName":"Assigned Group ID", "newName" : "assignedGroup"},
+    {"oldName":"Owner Group ID", "newName" : "ownerGroup"},
+    {"oldName":"Vendor Group ID", "newName" : "vendorGroup"},
+    {"oldName":"Person ID", "newName" : "customerId"},
+    {"oldName":"Direct Contact Person ID", "newName" : "contactId"},
+    {"oldName":"Requested By Person ID", "newName" :  "requestorId"},
+    {"oldName":"Impact", "newName" :  "impact"},
+    {"oldName":"Urgency", "newName" :  "urgency"},
+    {"oldName":"Priority", "newName" :  "priority"},
+    {"oldName":"Vendor Ticket Number", "newName" : "vendorTicketId"},
+    {"oldName":"Resolution", "newName":"resolution"}
+  ],
+  "newIncident":[
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"TemplateID", "newName" : "template"},
+    {"oldName":"Customer Person ID", "newName" : "customerId"},
+    {"oldName":"Detailed_Decription", "newName" : "detailedDescription"},
+    {"oldName":"Vendor Ticket Number", "newName" : "vendorTicketId"}
+  ],
+   "problem":[
+    {"oldName":"Problem Investigation ID", "newName" : "id"},
+    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
+    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
+    {"oldName":"Categorization Tier 1", "newName" : "opsCat1"},
+    {"oldName":"Categorization Tier 2", "newName" : "opsCat2"},
+    {"oldName":"Categorization Tier 3", "newName" : "opsCat3"},
+    {"oldName":"Product Categorization Tier 1", "newName" : "prodCat1"},
+    {"oldName":"Product Categorization Tier 2", "newName" : "prodCat2"},
+    {"oldName":"Product Categorization Tier 3", "newName" : "prodCat3"},
+    {"oldName":"Product Name", "newName" : "productName"},
+    {"oldName":"Manufacturer", "newName" : "manufacturer"},
+    {"oldName":"Detailed Decription", "newName" : "detailedDescription"},
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"Status Reason", "newName" : "statusReason"},
+    {"oldName":"Status", "newName" : "status"},
+    {"oldName":"Assigned Group ID", "newName" : "assignedGroup"},
+    {"oldName":"Owner Group ID", "newName" : "ownerGroup"},
+    {"oldName":"Vendor Group ID", "newName" : "vendorGroup"},
+    {"oldName":"Person ID", "newName" : "customerId"},
+    {"oldName":"Direct Contact Person ID", "newName" : "contactId"},
+    {"oldName":"Requested By Person ID", "newName" :  "requestorId"},
+    {"oldName":"Impact", "newName" :  "impact"},
+    {"oldName":"Urgency", "newName" :  "urgency"},
+    {"oldName":"Priority", "newName" :  "priority"}
+  ],
+  "newProblem":[
+    {"oldName":"Description", "newName" : "summary"},
+    {"oldName":"TemplateID", "newName" : "template"},
+    {"oldName":"Customer Person ID", "newName" : "customerId"},
+    {"oldName":"Detailed Decription", "newName" : "detailedDescription"}
+  ],
+  "task":[
+    {"oldName":"Summary", "newName" : "summary"},
+    {"oldName":"Notes", "newName" : "notes"},
+    {"oldName":"Task ID", "newName" : "id"},
+    {"oldName":"Status", "newName" : "status"},
+    {"oldName":"StatusReasonSelection", "newName" : "statusReason"},
+    {"oldName":"Actual Start Date", "newName" : "actualStartDate"},
+    {"oldName":"Actual End Date", "newName" : "actualEndDate"},
+    {"oldName":"Scheduled Start Date", "newName" : "scheduledStartDate"},
+    {"oldName":"Scheduled End Date", "newName" : "scheduledEndDate"},
+    {"oldName":"InstanceId", "newName" : "instanceId"},
+    {"oldName":"RootRequestFormName", "newName" : "rootRequestForm"},
+    {"oldName":"RootRequestID", "newName" : "rootRequest"},
+    {"oldName":"Sequence", "newName" : "sequence"},
+    {"oldName":"Service Cat Tier 1", "newName" : "opsCat1"},
+    {"oldName":"Service Cat Tier 2", "newName" : "opsCat2"},
+    {"oldName":"Service Cat Tier 3", "newName" : "opsCat3"},
+    {"oldName":"Product Cat Tier 1", "newName" : "prodCat1"},
+    {"oldName":"Product Cat Tier 2", "newName" : "prodCat2"},
+    {"oldName":"Product Cat Tier 3", "newName" : "prodCat3"},
+    {"oldName":"Product Name", "newName" : "productName"},
+    {"oldName":"Assignee Group ID", "newName" : "assignedGroup"},
+    {"oldName":"Customer Person ID", "newName" : "customerId"},
+    {"oldName":"Requested By Person ID", "newName" :  "requestorId"},
+    {"oldName":"Character 01", "newName" :  "character01"},
+    {"oldName":"Character 06", "newName" :  "character06"},
+    {"oldName":"Support Company", "newName" : "supportCompany"},
+    {"oldName":"Assignee Organization", "newName" : "supportOrganization"},
+    {"oldName":"Assignee Group", "newName" : "supportGroup"}
+  ],
+  "newTask":[
+    {"oldName":"Summary", "newName" : "summary"},
+    {"oldName":"Notes", "newName" : "notes"},
+    {"oldName":"Support Company", "newName" : "supportCompany"},
+    {"oldName":"Assignee Organization", "newName" : "supportOrganization"},
+    {"oldName":"Assignee Group", "newName" : "supportGroup"},
+    {"oldName":"RootRequestFormName", "newName" : "RootRequestFormName"},
+    {"oldName":"RootRequestName", "newName" : "RootRequestName"},
+    {"oldName":"RootRequestMode", "newName" : "RootRequestMode"},
+    {"oldName":"RootRequestInstanceId", "newName" : "RootRequestInstanceId"},
+    {"oldName":"Sequence", "newName" : "Sequence"},
+    {"oldName":"TaskName", "newName" : "TaskName"},
+    {"oldName":"Character 01", "newName" :  "character01"},
+    {"oldName":"Character 06", "newName" :  "character06"}
+  ],
+  "taskWorkLog":[
+    {"oldName":"Summary", "newName" : "Summary"},
+    {"oldName":"Notes", "newName" : "Notes"},
+    {"oldName":"Secure Log", "newName" : "Secure Log"},
+    {"oldName":"Communication Source", "newName" : "Communication Source"},
+    {"oldName":"WorkInfoType", "newName" : "WorkInfoType"},
+    {"oldName":"TaskOrTaskGroupID", "newName" : "TaskOrTaskGroupID"},
+    {"oldName":"TaskOrTaskGroupInstanceId", "newName" : "TaskOrTaskGroupInstanceId"}
+  ],
+  "flowBuilder":[
+    {"oldName":"RootRequestFormName", "newName" : "RootRequestFormName"},
+    {"oldName":"RootRequestName", "newName" : "RootRequestName"},
+    {"oldName":"RootRequestInstanceId", "newName" : "RootRequestInstanceId"},
+    {"oldName":"zTmpInternalCommand", "newName" : "zTmpInternalCommand"},
+    {"oldName":"Parent Type", "newName" : "Parent Type"},
+    {"oldName":"ParentID", "newName" : "ParentID"},
+    {"oldName":"Parent Name", "newName" : "Parent Name"}
+  ]
+}
+{% endhighlight %}

package/docs/howto/token.md

@@ -0,0 +1,71 @@
+---
+layout: page
+title: Authentication
+subtitle: How to get a token
+---
+
+Our API integrates with any OpenID Connect Server for authentication. If you use [Keycloak](https://www.keycloak.org/) as we do, here is how to get a token.
+
+## Request Definition
+
+To create a token you need to do a POST request to your SSO Server token url. Use Basic Authentication with your clientId and secret and sent grant_type=client_credentials as body.
+
+### URL
+
+*URL*: https://*sso-fqdn*/auth/realms/*realm*/protocol/openid-connect/token
+
+*sso-fqdn*: The hostname of your SSO Server / Identity Provider
+
+*realm*: Your security realm. e.G. isapi
+
+### Headers
+
+*Content-Type*: application/x-www-form-urlencoded
+
+### Authorization
+
+*Type*: Basic Auth
+
+*Username*: Your API ClientId
+
+*Password*: Your API Secret
+
+### Body
+
+*key*: grant_type
+
+*value*: client_credentials
+
+## Sample Request
+
+{% highlight http linenos %}
+POST /auth/realms/itsmproxy/protocol/openid-connect/token HTTP/1.1
+Host: sso.manyos.it
+Content-Type: application/x-www-form-urlencoded
+Authorization: Basic aXNtczpiMWQwNWUYkdi3mnslODZjNy02MWVdlkgwM2Q=
+User-Agent: PostmanRuntime/7.15.2
+Accept: */*
+Cache-Control: no-cache
+Host: sso.manyos.it
+
+grant_type=client_credentials
+{% endhighlight %}
+
+## Sample Response
+
+{% highlight json linenos %}
+{
+    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJFUUYxX01tM0lxaXNscEFNdEpQb0FKQmFiVk5CajRrMXdLUEJYUFlfZDRBIn0.eyJqdGkiOiJmZWFkZjc0OS05OGFhLTQ1MmUtYThlYi04Y2JjNzFlNDNmNjYiLCJleHAiOjE1NjU2MzM1MzUsIm5iZiI6MCwiaWF0IjoxNTY1NjE1NTM1LCJpc3MiOiJodHRwczovL3Nzby5tYW55b3MuaXQvYXV0aC9yZWFsbXMvaXRzbXByb3h5IiwiYXVkIjpbImlzc20iLCJhY2NvdW50Il0sInN1YiI6IjI1NWU5MGRjLTczYWItNDJkOS1iOTUyLTYwY2VjNzE2YzRlOCIsInR5cCI6IkJlYXJlciIsImF6cCI6ImlzbXMiLCJhdXRoX3RpbWUiOjAsInNlc3Npb25fc3RhdGUiOiJjMmIxZGE3YS1kZGM0LTQ5M2MtYjIwYi0zN2Y0NTExYWQyZTciLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6Imlzc20gaXRzbXByb3h5QmFzaWMgY21kYm9iamVjdFJlYWQiLCJjbGllbnRIb3N0IjoiMjEyLjExNC4xMzAuOTMiLCJjbGllbnRJZCI6ImlzbXMiLCJjbGllbnRBZGRyZXNzIjoiMjEyLjExNC4xMzAuOTMifQ.TOdFNfiBUgu5CwWZ6IOCahJkr4FYbWM9hK5yblQR06uDaJkRx_c7NEwVRRXnYPFs9rtAgCycYwYap8hKKZqZpExQmBSmRgHzyMZVEw67V3kiFlNaok83czuE2Ka1vC8le4LbQuLmwOeIWa0UIiOZlxpskZgJ4vBomotewbKC4-w2WwB-5zieuO48aohP8voY6oyYFWNMJJyvlubDbC1eUhCmwMaTOWDw0wtkYQDxKNPX_toPxa8aRIy0rXpRYINRiAP4zsyI9IBSoyAxiHWwMbKutVpnvZsSl_Rny2lsw1xnLWQe2nXlKwAEVYZ7Bz6U6krvi_oRfpWUoP5OdfYKhg",
+    "expires_in": 18000,
+    "refresh_expires_in": 1800,
+    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJmZTBiYzQ4My1hZTcxLTQ1M2UtODQ5Zi02M2MyZTAwMWQwZTAifQ.eyJqdGkiOiJlZDUzNjRiZi03ZTU3LTRkMTEtOGY4Mi00ZmEwYmVhNWZkM2QiLCJleHAiOjE1NjU2MTczMzUsIm5iZiI6MCwiaWF0IjoxNTY1NjE1NTM1LCJpc3MiOiJodHRwczovL3Nzby5tYW55b3MuaXQvYXV0aC9yZWFsbXMvaXRzbXByb3h5IiwiYXVkIjoiaHR0cHM6Ly9zc28ubWFueW9zLml0L2F1dGgvcmVhbG1zL2l0c21wcm94eSIsInN1YiI6IjI1NWU5MGRjLTczYWItNDJkOS1iOTUyLTYwY2VjNzE2YzRlOCIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJpc21zIiwiYXV0aF90aW1lIjowLCJzZXNzaW9uX3N0YXRlIjoiYzJiMWRhN2EtZGRjNC00OTNjLWIyMGItMzdmNDUxMWFkMmU3IiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6Imlzc20gaXRzbXByb3h5QmFzaWMgY21kYm9iamVjdFJlYWQifQ.4QxcaZ7TILPKsOcPKHUfXhT_rRIku8ewP2iScVHVD64",
+    "token_type": "bearer",
+    "not-before-policy": 0,
+    "session_state": "c2b1da7a-ddc4-493c-b20b-37f4511ad2e7",
+    "scope": "itsmproxy cmdbobjectRead"
+}
+{% endhighlight %}
+
+You can now use the access token to authorize your requests. Set a header with the key "Authorization" and the value "Bearer <access-token>".
+
+Learn more about JSON Web Tokens on [jwt.io](https://jwt.io)