SCIM API endpoint details and syntax for users

Don't forget to come by and check out our new RESTful JSON APIs, they can help you utilize and extend Quickbase with ease.

 

The Quickbase API endpoints support the SCIM 2.0 protocol and allows for username creates, reads, updates, and deletes (CRUD) via the following HTTP methods:

  • GET

  • POST

  • PUT

  • DELETE

A bearer token is used for authentication using a Quickbase user token. Read Setting up a user and user token for SCIM provisioning for details.

Quickbase supports the following via CRUD:

  • Get users in a realm

  • Create users/Provision users

  • Search for users in app or realm

  • Update/edit user information

  • Deny/restore users

  • Delete users

Note: The Patch endpoint is not supported.

Required user fields are:

  • userName

  • name

  • emails

  • active

  • externalID

The following sections provide syntax examples.

Get users in a realm

Note: The username eq filter query is supported.

  • Get all users: GET { SCIMBaseURL}/users
  • Get users with pagination: GET { SCIMBaseURL}/users?count=1&startIndex=1
  • Get users with userId: GET { SCIMBaseURL}/users/{userId}
  • Get users with userName filter: GET { SCIMBaseURL}/users?filter=userName eq "{userName}"
Setup of all calls
{ SCIMBaseURL} = {BaseURL}/ governance/scim/v2/
Create users/Provision users

Note: New users are created as approved, registered and verified. Once provisioned, the new users need to sign in to Quickbase via SSO.

POST { SCIMBaseURL}/users 
 { 
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], 
    "userName": “Jane.doe", 
    "name": { 
        "givenName": "Jane", 
        "familyName": "Doe" 
    }, 
    "emails": [{ 
        "primary": true, 
        "value": " jane.doe@example.com" 
    }], 
    "externalId": "00uv931EiyRsnwOGa0g3", 
    "active": true 
} 
Update/edit user information
PUT { SCIMBaseURL}/users/{userId} 
 { 
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], 
    "userName": “ jane.smith", 
    "name": { 
        "givenName": "Jane", 
        "familyName": “Smith" 
    }, 
    "emails": [{ 
        "primary": true, 
        "value": " jane.smith@example.com" 
    }], 
    "externalId": "00uv931EiyRsnwOGa0g3", 
    "active": true 
} 
Deny users
PUT { SCIMBaseURL}/users/{userId} 
 { 
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], 
    "userName": “ jane.smith", 
    "name": { 
        "givenName": "Jane", 
        "familyName": “Smith" 
    }, 
    "emails": [{ 
        "primary": true, 
        "value": " jane.smith@example.com" 
    }], 
    "externalId": "00uv931EiyRsnwOGa0g3", 
     "active": false 
} 
Approve users
PUT { SCIMBaseURL}/users/{userId} 
 { 
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], 
    "userName": “ jane.smith", 
    "name": { 
        "givenName": "Jane", 
        "familyName": “Smith" 
    }, 
    "emails": [{ 
        "primary": true, 
        "value": " jane.smith@example.com" 
    }], 
    "externalId": "00uv931EiyRsnwOGa0g3", 
     "active": true 
}  
Delete users
DELETE { SCIMBaseURL}/users/{userId} 
Related Topics: