SQL Server / Postman API / Update User Information
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "schemas": [
-- "urn:ietf:params:scim:schemas:core:2.0:User"
-- ],
-- "userName": "{{userEmail}}",
-- "name": {
-- "givenName": "Test",
-- "familyName": "User"
-- },
-- "externalId": "23123123",
-- "locale": "en-US",
-- "groups": [
-- ],
-- "active": true
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'schemas[0]', 'urn:ietf:params:scim:schemas:core:2.0:User'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'userName', '{{userEmail}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name.givenName', 'Test'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name.familyName', 'User'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'externalId', '23123123'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'locale', 'en-US'
EXEC sp_OAMethod @json, 'UpdateNewArray', @success OUT, 'groups'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'active', 1
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{apiKey}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-API-Key', '{{postman_api_key}}'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://api.getpostman.com/scim/v2/Users/{{id}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
Curl Command
curl -X PUT
-H "X-API-Key: {{postman_api_key}}"
-H "Authorization: {{apiKey}}"
-d '{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "{{userEmail}}",
"name": {
"givenName": "Test",
"familyName": "User"
},
"externalId": "23123123",
"locale": "en-US",
"groups": [],
"active": true
}'
https://api.getpostman.com/scim/v2/Users/{{id}}
Postman Collection Item JSON
{
"name": "Update User Information",
"request": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"externalId\": \"23123123\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.getpostman.com/scim/v2/Users/{{id}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"scim",
"v2",
"Users",
"{{id}}"
]
},
"description": "Updates a user’s first and last name in Postman. \n\n> Only updates made to the user’s given and family name via the SCIM API will be pushed to Postman. No other user attributes can be updated in Postman using the SCIM API."
},
"response": [
{
"name": "200",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apikey}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"externalId\": \"23123123\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"id\": \"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99\",\n \"userName\": \"test.user@okta.local\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"externalId\": \"23123123\",\n \"active\": true,\n \"meta\": {\n \"resourceType\": \"User\",\n \"created\": \"2021-02-22T04:24:13.000Z\",\n \"lastModified\": \"2021-02-22T04:24:13.000Z\"\n }\n}"
},
{
"name": "400 - Can't update username",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"emails\": [{\n \"primary\": true,\n \"value\": \"{{userEmail}}\",\n \"type\": \"work\"\n }],\n \"displayName\": \"Test User\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"detail\": \"Couldn’t update this team member’s username. Try again — it should work next time around.\",\n \"status\": \"400\"\n}"
},
{
"name": "400 - Invalid team",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"emails\": [{\n \"primary\": true,\n \"value\": \"{{userEmail}}\",\n \"type\": \"work\"\n }],\n \"displayName\": \"Test User\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"detail\": \"This Postman team doesn’t exist anymore.\",\n \"status\": \"400\"\n}"
},
{
"name": "401 - Invalid API key",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "invalidApiKey",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"emails\": [{\n \"primary\": true,\n \"value\": \"{{userEmail}}\",\n \"type\": \"work\"\n }],\n \"displayName\": \"Test User\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"detail\": \"Unable to access the team. Check if you have entered a valid API key.\",\n \"status\": \"401\"\n}"
},
{
"name": "403 - Admin Team Mismatch",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"emails\": [{\n \"primary\": true,\n \"value\": \"{{userEmail}}\",\n \"type\": \"work\"\n }],\n \"displayName\": \"Test User\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"detail\": \"Your API key was generated by a Team Admin who is no longer on your team. Use an API key generated by a Team Admin.\",\n \"status\": \"403\"\n}"
},
{
"name": "400 - Invalid payload",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"scimType\": \"invalidSyntax\",\n \"detail\": \"The request body seems to be incomplete or have unsupported characters.\",\n \"status\": \"400\"\n}"
},
{
"name": "403 - Admin action not allowed",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"externalId\": \"23123123\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"detail\": \"The admin is not allowed to perform this action.\",\n \"status\": \"403\"\n}"
},
{
"name": "403 - User not in Team",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"emails\": [{\n \"primary\": true,\n \"value\": \"{{userEmail}}\",\n \"type\": \"work\"\n }],\n \"displayName\": \"Test User\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"detail\": \"This person isn’t a member of the team.\",\n \"status\": \"403\"\n}"
},
{
"name": "404 - User Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"emails\": [{\n \"primary\": true,\n \"value\": \"{{userEmail}}\",\n \"type\": \"work\"\n }],\n \"displayName\": \"Test User\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"detail\": \"This person isn’t a member of the team.\",\n \"status\": \"404\"\n}"
},
{
"name": "429 - Rate limit exceeded",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"externalId\": \"23123123\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"code": 429,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"detail\": \"That’s 180 attempts in less than a minute. Wait for a minute and then try again.\",\n \"status\": 429\n}"
},
{
"name": "500 - Something went wrong",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Authorization",
"value": "{{apiKey}}",
"type": "text"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"schemas\": [\"urn:ietf:params:scim:schemas:core:2.0:User\"],\n \"userName\": \"{{userEmail}}\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"emails\": [{\n \"primary\": true,\n \"value\": \"{{userEmail}}\",\n \"type\": \"work\"\n }],\n \"displayName\": \"Test User\",\n \"locale\": \"en-US\",\n \"groups\": [],\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/Users/405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99",
"host": [
"{{url}}"
],
"path": [
"Users",
"405775fe15ed41872a8eea4c8aa2b38cda9749812cc55c99"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:Error\"\n ],\n \"detail\": \"Couldn’t update this team member’s information. Try again — it should work next time around.\",\n \"status\": \"500\"\n}"
}
]
}
