SCIM API endpoint details and syntax

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

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

Quick Base supports the following via CRUD:

Note: The Patch endpoint is not supported.

Required user fields are:

The following sections provide syntax examples.

Get users in a realm

Note: The username eq filter query is supported.

GET all users: { SCIMBaseURL}/users
GET users with pagination:  { SCIMBaseURL}/users?count=1&startIndex=1
GET user with userId: { SCIMBaseURL}/users/{userId}
GET user with userName filter: { SCIMBaseURL}/users?filter=userName eq "{userName}"
Create users/Provision users

Note: New users are created as approved, registered and verified. Once provisioned, the new users need to sign in to Quick Base 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} 

{ SCIMBaseURL} = {BaseURL}/ governance/scim/v2/
Related Topics:

 

Go back    |     |  

© 1999-2018 QuickBase, Inc. All rights reserved. Legal Notices.