cURL
curl -sS -X POST 'http://localhost:8081/scim/v2/Bulk' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json' \
-H 'Content-Type: application/scim+json' \
-d '{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:BulkRequest"
],
"failOnErrors": 1,
"Operations": [
{
"bulkId": "bulk-test",
"method": "POST",
"path": "/Users",
"data": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"
],
"userName": "testa@example.com",
"name": {
"givenName": "Name",
"familyName": "ExampleSurname"
},
"emails": [
{
"value": "testa@example.com",
"primary": true
},
{
"value": "testb@email.com",
"primary": false
}
],
"addresses": [
{
"type": "home",
"primary": true,
"country": "US",
"streetAddress": "Test address",
"postalCode": "37076",
"region": "test state",
"locality": "TN"
}
],
"id": "55907ba0-6ee8-4c6c-90a9-8aeccb9b82dc",
"phoneNumbers": [
{
"value": "6155555555",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"packageId": "d41ebe30-279f-41cd-8ag5-7257854d82e5",
"skipUserActivation": true,
"cpfNumber": "87452365895"
}
}
},
{
"method": "PUT",
"path": "/Users/4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
"data": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"
],
"userName": "dev+admin@firstbasedev.com",
"name": {
"givenName": "Test Given Name",
"familyName": "Test familyName"
},
"emails": [
{
"value": "test+swaggera@firstbasedev.com",
"primary": true
},
{
"value": "test+swaggerb@firstbasedev.com",
"primary": false
}
],
"addresses": [
{
"type": "home",
"primary": true,
"country": "US",
"streetAddress": "Test address ",
"postalCode": "37076",
"region": "test state",
"locality": "TN"
}
],
"id": "4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
"phoneNumbers": [
{
"value": "6155555555",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"packageId": "d82ebe36-299f-40ce-8af7-7157853d80d9",
"skipUserActivation": true,
"cpfNumber": "87452365895"
}
}
}
]
}'import requests
url = "http://localhost:8081/scim/v2/Bulk"
payload = {
"schemas": ["urn:ietf:params:scim:api:messages:2.0:BulkRequest"],
"failOnErrors": 1,
"Operations": [
{
"bulkId": "bulk-test",
"method": "POST",
"path": "/Users",
"data": {
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"],
"userName": "testa@example.com",
"name": {
"givenName": "Name",
"familyName": "ExampleSurname"
},
"emails": [
{
"value": "testa@example.com",
"primary": True
},
{
"value": "testb@email.com",
"primary": False
}
],
"addresses": [
{
"type": "home",
"primary": True,
"country": "US",
"streetAddress": "Test address",
"postalCode": "37076",
"region": "test state",
"locality": "TN"
}
],
"id": "55907ba0-6ee8-4c6c-90a9-8aeccb9b82dc",
"phoneNumbers": [
{
"value": "6155555555",
"primary": True
}
],
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"packageId": "d41ebe30-279f-41cd-8ag5-7257854d82e5",
"skipUserActivation": True,
"cpfNumber": "87452365895"
}
}
},
{
"method": "PUT",
"path": "/Users/4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
"data": {
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"],
"userName": "dev+admin@firstbasedev.com",
"name": {
"givenName": "Test Given Name",
"familyName": "Test familyName"
},
"emails": [
{
"value": "test+swaggera@firstbasedev.com",
"primary": True
},
{
"value": "test+swaggerb@firstbasedev.com",
"primary": False
}
],
"addresses": [
{
"type": "home",
"primary": True,
"country": "US",
"streetAddress": "Test address ",
"postalCode": "37076",
"region": "test state",
"locality": "TN"
}
],
"id": "4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
"phoneNumbers": [
{
"value": "6155555555",
"primary": True
}
],
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"packageId": "d82ebe36-299f-40ce-8af7-7157853d80d9",
"skipUserActivation": True,
"cpfNumber": "87452365895"
}
}
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/scim+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/scim+json'},
body: JSON.stringify({
schemas: ['urn:ietf:params:scim:api:messages:2.0:BulkRequest'],
failOnErrors: 1,
Operations: [
{
bulkId: 'bulk-test',
method: 'POST',
path: '/Users',
data: {
schemas: [
'urn:ietf:params:scim:schemas:core:2.0:User',
'urn:ietf:params:scim:schemas:extension:firstbase:1.0:User'
],
userName: 'testa@example.com',
name: {givenName: 'Name', familyName: 'ExampleSurname'},
emails: [
{value: 'testa@example.com', primary: true},
{value: 'testb@email.com', primary: false}
],
addresses: [
{
type: 'home',
primary: true,
country: 'US',
streetAddress: 'Test address',
postalCode: '37076',
region: 'test state',
locality: 'TN'
}
],
id: '55907ba0-6ee8-4c6c-90a9-8aeccb9b82dc',
phoneNumbers: [{value: '6155555555', primary: true}],
'urn:ietf:params:scim:schemas:extension:firstbase:1.0:User': {
packageId: 'd41ebe30-279f-41cd-8ag5-7257854d82e5',
skipUserActivation: true,
cpfNumber: '87452365895'
}
}
},
{
method: 'PUT',
path: '/Users/4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03',
data: {
schemas: [
'urn:ietf:params:scim:schemas:core:2.0:User',
'urn:ietf:params:scim:schemas:extension:firstbase:1.0:User'
],
userName: 'dev+admin@firstbasedev.com',
name: {givenName: 'Test Given Name', familyName: 'Test familyName'},
emails: [
{value: 'test+swaggera@firstbasedev.com', primary: true},
{value: 'test+swaggerb@firstbasedev.com', primary: false}
],
addresses: [
{
type: 'home',
primary: true,
country: 'US',
streetAddress: 'Test address ',
postalCode: '37076',
region: 'test state',
locality: 'TN'
}
],
id: '4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03',
phoneNumbers: [{value: '6155555555', primary: true}],
'urn:ietf:params:scim:schemas:extension:firstbase:1.0:User': {
packageId: 'd82ebe36-299f-40ce-8af7-7157853d80d9',
skipUserActivation: true,
cpfNumber: '87452365895'
}
}
}
]
})
};
fetch('http://localhost:8081/scim/v2/Bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"<string>"{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}People
Bulk operations
Performs bulk operations using the SCIM protocol as defined by RFC 7644.
POST
http://localhost:8081
/
scim
/
v2
/
Bulk
cURL
curl -sS -X POST 'http://localhost:8081/scim/v2/Bulk' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json' \
-H 'Content-Type: application/scim+json' \
-d '{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:BulkRequest"
],
"failOnErrors": 1,
"Operations": [
{
"bulkId": "bulk-test",
"method": "POST",
"path": "/Users",
"data": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"
],
"userName": "testa@example.com",
"name": {
"givenName": "Name",
"familyName": "ExampleSurname"
},
"emails": [
{
"value": "testa@example.com",
"primary": true
},
{
"value": "testb@email.com",
"primary": false
}
],
"addresses": [
{
"type": "home",
"primary": true,
"country": "US",
"streetAddress": "Test address",
"postalCode": "37076",
"region": "test state",
"locality": "TN"
}
],
"id": "55907ba0-6ee8-4c6c-90a9-8aeccb9b82dc",
"phoneNumbers": [
{
"value": "6155555555",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"packageId": "d41ebe30-279f-41cd-8ag5-7257854d82e5",
"skipUserActivation": true,
"cpfNumber": "87452365895"
}
}
},
{
"method": "PUT",
"path": "/Users/4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
"data": {
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"
],
"userName": "dev+admin@firstbasedev.com",
"name": {
"givenName": "Test Given Name",
"familyName": "Test familyName"
},
"emails": [
{
"value": "test+swaggera@firstbasedev.com",
"primary": true
},
{
"value": "test+swaggerb@firstbasedev.com",
"primary": false
}
],
"addresses": [
{
"type": "home",
"primary": true,
"country": "US",
"streetAddress": "Test address ",
"postalCode": "37076",
"region": "test state",
"locality": "TN"
}
],
"id": "4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
"phoneNumbers": [
{
"value": "6155555555",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"packageId": "d82ebe36-299f-40ce-8af7-7157853d80d9",
"skipUserActivation": true,
"cpfNumber": "87452365895"
}
}
}
]
}'import requests
url = "http://localhost:8081/scim/v2/Bulk"
payload = {
"schemas": ["urn:ietf:params:scim:api:messages:2.0:BulkRequest"],
"failOnErrors": 1,
"Operations": [
{
"bulkId": "bulk-test",
"method": "POST",
"path": "/Users",
"data": {
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"],
"userName": "testa@example.com",
"name": {
"givenName": "Name",
"familyName": "ExampleSurname"
},
"emails": [
{
"value": "testa@example.com",
"primary": True
},
{
"value": "testb@email.com",
"primary": False
}
],
"addresses": [
{
"type": "home",
"primary": True,
"country": "US",
"streetAddress": "Test address",
"postalCode": "37076",
"region": "test state",
"locality": "TN"
}
],
"id": "55907ba0-6ee8-4c6c-90a9-8aeccb9b82dc",
"phoneNumbers": [
{
"value": "6155555555",
"primary": True
}
],
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"packageId": "d41ebe30-279f-41cd-8ag5-7257854d82e5",
"skipUserActivation": True,
"cpfNumber": "87452365895"
}
}
},
{
"method": "PUT",
"path": "/Users/4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
"data": {
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:firstbase:1.0:User"],
"userName": "dev+admin@firstbasedev.com",
"name": {
"givenName": "Test Given Name",
"familyName": "Test familyName"
},
"emails": [
{
"value": "test+swaggera@firstbasedev.com",
"primary": True
},
{
"value": "test+swaggerb@firstbasedev.com",
"primary": False
}
],
"addresses": [
{
"type": "home",
"primary": True,
"country": "US",
"streetAddress": "Test address ",
"postalCode": "37076",
"region": "test state",
"locality": "TN"
}
],
"id": "4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03",
"phoneNumbers": [
{
"value": "6155555555",
"primary": True
}
],
"urn:ietf:params:scim:schemas:extension:firstbase:1.0:User": {
"packageId": "d82ebe36-299f-40ce-8af7-7157853d80d9",
"skipUserActivation": True,
"cpfNumber": "87452365895"
}
}
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/scim+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/scim+json'},
body: JSON.stringify({
schemas: ['urn:ietf:params:scim:api:messages:2.0:BulkRequest'],
failOnErrors: 1,
Operations: [
{
bulkId: 'bulk-test',
method: 'POST',
path: '/Users',
data: {
schemas: [
'urn:ietf:params:scim:schemas:core:2.0:User',
'urn:ietf:params:scim:schemas:extension:firstbase:1.0:User'
],
userName: 'testa@example.com',
name: {givenName: 'Name', familyName: 'ExampleSurname'},
emails: [
{value: 'testa@example.com', primary: true},
{value: 'testb@email.com', primary: false}
],
addresses: [
{
type: 'home',
primary: true,
country: 'US',
streetAddress: 'Test address',
postalCode: '37076',
region: 'test state',
locality: 'TN'
}
],
id: '55907ba0-6ee8-4c6c-90a9-8aeccb9b82dc',
phoneNumbers: [{value: '6155555555', primary: true}],
'urn:ietf:params:scim:schemas:extension:firstbase:1.0:User': {
packageId: 'd41ebe30-279f-41cd-8ag5-7257854d82e5',
skipUserActivation: true,
cpfNumber: '87452365895'
}
}
},
{
method: 'PUT',
path: '/Users/4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03',
data: {
schemas: [
'urn:ietf:params:scim:schemas:core:2.0:User',
'urn:ietf:params:scim:schemas:extension:firstbase:1.0:User'
],
userName: 'dev+admin@firstbasedev.com',
name: {givenName: 'Test Given Name', familyName: 'Test familyName'},
emails: [
{value: 'test+swaggera@firstbasedev.com', primary: true},
{value: 'test+swaggerb@firstbasedev.com', primary: false}
],
addresses: [
{
type: 'home',
primary: true,
country: 'US',
streetAddress: 'Test address ',
postalCode: '37076',
region: 'test state',
locality: 'TN'
}
],
id: '4599d8bb-b6df-4ed2-9ad2-6907f8b1fa03',
phoneNumbers: [{value: '6155555555', primary: true}],
'urn:ietf:params:scim:schemas:extension:firstbase:1.0:User': {
packageId: 'd82ebe36-299f-40ce-8af7-7157853d80d9',
skipUserActivation: true,
cpfNumber: '87452365895'
}
}
}
]
})
};
fetch('http://localhost:8081/scim/v2/Bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"<string>"{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Authorizations
Prefix the value with "ApiKey" to indicate the custom authorization type
Body
application/scim+json
The body is of type string.
Response
Bulk operation completed
The response is of type string.
⌘I