{{sidenavigation.sidenavigationExpandLabel}}
{{getMsg('Help_YouAreHere')}}: {{page.title}} {{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}} {{helpModel.downloadHelpPdfDataStatus}}

SCIM Schemas

An HTTP GET to this endpoint is used to retrieve information about resource schemas supported by i-net HelpDesk. It will return all supported schemas when used as the /schemas endpoint and will return a specific schema if used with an extension, e.g. /Schemas/urn:ietf:params:scim:schemas:core:2.0:User

GET /api/scim/v2/schemas/<SCHEMA ID>

The <SCHEMA ID> is optional to fetch a specific schema only. The list of schemas returns a response that conforms to RFC 7643. There are also schema examples available here.

Example Request

# Request
GET /api/scim/v2/schemas/urn:ietf:params:scim:schemas:core:2.0:User HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response
HTTP/1.1 200 OK
Content-Type: application/scim+json
 
{
  "meta": {
    "location": "https://helpdesk.testing.internal.inetsoftware.de/api/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User",
    "resourceType": "Schema"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ],
  "name": "User",
  "description": "User Account",
  "attributes": [
    {
      "uniqueness": "server",
      "name": "userName",
      "description": "Unique identifier for the User",
      "mutability": "readWrite",
      "type": "string",
      "multiValued": false,
      "caseExact": false,
      "returned": "default",
      "required": true
    },
    ...
   ],
  "id": "urn:ietf:params:scim:schemas:core:2.0:User"
}

Application Example

# Browser access
https://127.0.0.1:9000/api/scim/v2/schemas
 
# Shell access using curl
curl -LsH "Authorization: Bearer <access_token>" "https://127.0.0.1:9000/api/scim/v2/schemas"
 
# Shell access using curl using username and password
curl -Lsu username:password "https://127.0.0.1:9000/api/scim/v2/schemas"
i-net HelpDesk
This application uses cookies to allow login. By continuing to use this application, you agree to the use of cookies.


Help - /Schemas