Skip to main content

Lattice SCIM API Schema

Use the following URL to access the SCIM API schemas for User Provisioning: https://api.latticehq.com/scim/v2/schemas Below is an example ...

A
Written by Adam Kroboth

Use the following URL to access the SCIM API schemas for User Provisioning: https://api.latticehq.com/scim/v2/schemas

Below is an example of a Lattice Field Schema:

{
   "schemas": [
       "urn:ietf:params:scim:schemas:core:2.0:User",
       "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
       "urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User"
  ],
   "id": "52d2420e-cbd0-11ec-bfdd-93fec5413bdc",
   "externalId": null,
   "name": {
       "formatted": "First Last",
       "familyName": null,
       "givenName": null,
       "middleName": null
  },
   "displayName": "First Last",
   "nickName": "First",
   "userName": "[email protected]",
   "profileUrl": "https://companyname.latticehq.com/users/52d2420e-cbd0-11ec-bfdd-93fec5413bdc",
   "title": "People Operations",
   "timezone": "America/Los_Angeles",
   "active": true,
   "emails": [
      {
           "value": "[email protected]",
           "type": "work",
           "primary": true
      }
  ],
   "phoneNumbers": [
      {
           "value": "123-456-7890",
           "type": "work"
      }
  ],
   "photos": [
      {
           "value":
           "type": "thumbnail"
      }
  ],
   "groups": [],
   "meta": {
       "resourceType": "User",
       "created": "2022-01-01T17:33:40.434Z",
       "lastModified": "2022-06-01T23:18:18.025Z",
       "location": "https://api.latticehq.com/scim/v2/Users/52d2420e-cbd0-11ec-bfdd-93fec5413bdc"
  },
   "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
       "department": "People Operations",
       "manager": {
           "value": "52d2780a-cbd0-11ec-a46c-f74aca5988d8",
           "$ref": "/scim/v2/52d2780a-cbd0-11ec-a46c-f74aca5988d8",
           "displayName": "Manager Name"
      }
  },
   "urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User": {
       "startDate": "2017-01-01",
       "birthDate": "1992-04-18",
       "gender": "male",
       "Office Location": "SF",
       "GblPayBRAWorkLocationCity (Employee)": "Hybrid",
       "Tee Shirt Size": "Large"
  }
}

Please note to activate/deactivate the users in Lattice, you will need to set the active field to true/false.

Did this answer your question?