Single Sign On: API Reference – Documentation and Support | Knowi

Create User:

POST https://www.knowi.com/sso/user/create

Parameter	Type	Description
ssoCustomerToken	string	Required. customer-specific SSO Token to authorize SSO user management.
user	string	Required. email/username of the new or existing user.
userGroups[]	array of strings	An array of groups the user will be associated with. Note: Group will be created if it does not exist. Send an empty array ([]) to remove dissociate the user from all groups.
contentFilter	object	A JSON object to apply a row-level filter on data user is allowed to see. Ex: [{"fieldName": "region", "values":["Canada","Mexico"], "operator":"="}]
role	string	Role and permissions to assign the user. Defaults to system user if blank.
refresh	bool	If True, the user's properties (i.e. `userGroups[]`, `contentFilter`, `role`) will be updated with new values.

Returns:

A user-specific token. Store this for your user within your system.

Example:

curl  -i -X POST -d "userGroups[]=First Group&userGroups[]=Second Group&user=a@a.com&ssoCustomerToken=9ebdlklfWlYuQXPXanqHxq7ZflklfZ1pGC8Ny8l2is9uNhMie" https://www.knowi.com/sso/user/create
Returns a user token back.

Create Session:

POST https://www.knowi.com/sso/session/create

Parameter	Type	Description
user	string	Required. email/username of the existing user.
userToken	string	Required. token returned from user creation (`/sso/user/create`)

Returns:

A session Id/token

Example:

curl  -i -X POST -d "user=a@a.com&userToken=NUAslkrtRTTFMvscpiislikfyfhsgu491is7plqRvwvJGEgm7JVU8ie" https://www.knowi.com/sso/session/create
Returns a session token.

Delete User:

POST:  https://www.knowi.com/sso/user/remove

Parameter	Type	Description
user	string	Required. email/username of the existing user.
userToken	string	Required. token returned from user creation (`/sso/user/create`)
ssoCustomerToken	string	Required. customer-specific SSO Token to authorize SSO user management.

Update User Filter:

POST:  https://www.knowi.com/sso/user/contentfilters/update

Parameter	Type	Description
contentFilter	string	Required. a JSON object to apply a row-level filter on data user is allowed to see. Ex: [{"fieldName": "region", "values":["Italy"], "operator":"="}]
user	string	Required. email/username of the existing user.
ssoCustomerToken	string	Required. customer-specific SSO Token to authorize SSO user management.

Example:

    curl  -i -X POST -d "user=demoSSO@knowi.com&ssoCustomerToken=9ebdlklfWlYuQXPXanqHxq7ZflklfZ1pGC8Ny8l2is9uNhMie&contentFilter=[{\"fieldName\":\"customer\",\"values\":[\"Costco\"],\"operator\":\"=\"}]" https://www.knowi.com/sso/user/contentfilters/update

Related articles