User Groups
Create a user group
POST
/
user-groups
Create a user group
curl --request POST \
--url https://backend.branch.flowengineering.com/user-groups \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>' \
--data '
{
"name": "<string>",
"external_provider": "<string>",
"external_role": "<string>",
"member_ids": [
"<string>"
]
}
'import requests
url = "https://backend.branch.flowengineering.com/user-groups"
payload = {
"name": "<string>",
"external_provider": "<string>",
"external_role": "<string>",
"member_ids": ["<string>"]
}
headers = {
"customer": "<customer>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
customer: '<customer>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
external_provider: '<string>',
external_role: '<string>',
member_ids: ['<string>']
})
};
fetch('https://backend.branch.flowengineering.com/user-groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"external_provider": "<string>",
"external_role": "<string>",
"id": "<string>",
"member_ids": [
"<string>"
],
"name": "<string>",
"scim_managed": true
}Authorizations
api-keybearer
Headers
Workspace identifier
Body
application/json
⌘I
Create a user group
curl --request POST \
--url https://backend.branch.flowengineering.com/user-groups \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>' \
--data '
{
"name": "<string>",
"external_provider": "<string>",
"external_role": "<string>",
"member_ids": [
"<string>"
]
}
'import requests
url = "https://backend.branch.flowengineering.com/user-groups"
payload = {
"name": "<string>",
"external_provider": "<string>",
"external_role": "<string>",
"member_ids": ["<string>"]
}
headers = {
"customer": "<customer>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
customer: '<customer>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
external_provider: '<string>',
external_role: '<string>',
member_ids: ['<string>']
})
};
fetch('https://backend.branch.flowengineering.com/user-groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"external_provider": "<string>",
"external_role": "<string>",
"id": "<string>",
"member_ids": [
"<string>"
],
"name": "<string>",
"scim_managed": true
}