Update a user group.
curl --request PATCH \
--url https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"recordDefault": true,
"title": "<string>",
"automatedUserGroup": true,
"automatedUserGroupFieldLabel": "<string>",
"users": [
{
"id": "<string>",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"company": "<string>",
"imageUrl": "<string>",
"mfaEnabled": true,
"mfaSetup": true,
"autoprovisioned": true,
"scimStatus": "<string>",
"automatedUser": true,
"automatedUserFieldLabels": [
"<string>"
],
"lastLogin": {
"id": "<string>",
"accessType": "<string>"
},
"lastDeactivated": "2023-11-07T05:31:56Z",
"external": true,
"disabled": true,
"serviceAccount": true,
"superUser": true,
"name": "<string>",
"locked": true
}
],
"currentValue": {
"id": "<string>",
"discriminator": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true
}
}
'import requests
url = "https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}"
payload = {
"id": "<string>",
"recordDefault": True,
"title": "<string>",
"automatedUserGroup": True,
"automatedUserGroupFieldLabel": "<string>",
"users": [
{
"id": "<string>",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": True,
"email": "<string>",
"company": "<string>",
"imageUrl": "<string>",
"mfaEnabled": True,
"mfaSetup": True,
"autoprovisioned": True,
"scimStatus": "<string>",
"automatedUser": True,
"automatedUserFieldLabels": ["<string>"],
"lastLogin": {
"id": "<string>",
"accessType": "<string>"
},
"lastDeactivated": "2023-11-07T05:31:56Z",
"external": True,
"disabled": True,
"serviceAccount": True,
"superUser": True,
"name": "<string>",
"locked": True
}
],
"currentValue": {
"id": "<string>",
"discriminator": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
recordDefault: true,
title: '<string>',
automatedUserGroup: true,
automatedUserGroupFieldLabel: '<string>',
users: [
{
id: '<string>',
discriminator: '<string>',
status: '<string>',
idOrTransientId: '<string>',
transientIdOrId: '<string>',
textOrNumericValue: '<string>',
empty: true,
email: '<string>',
company: '<string>',
imageUrl: '<string>',
mfaEnabled: true,
mfaSetup: true,
autoprovisioned: true,
scimStatus: '<string>',
automatedUser: true,
automatedUserFieldLabels: ['<string>'],
lastLogin: {id: '<string>', accessType: '<string>'},
lastDeactivated: '2023-11-07T05:31:56Z',
external: true,
disabled: true,
serviceAccount: true,
superUser: true,
name: '<string>',
locked: true
}
],
currentValue: {
id: '<string>',
discriminator: '<string>',
idOrTransientId: '<string>',
transientIdOrId: '<string>',
textOrNumericValue: '<string>',
empty: true
}
})
};
fetch('https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'recordDefault' => true,
'title' => '<string>',
'automatedUserGroup' => true,
'automatedUserGroupFieldLabel' => '<string>',
'users' => [
[
'id' => '<string>',
'discriminator' => '<string>',
'status' => '<string>',
'idOrTransientId' => '<string>',
'transientIdOrId' => '<string>',
'textOrNumericValue' => '<string>',
'empty' => true,
'email' => '<string>',
'company' => '<string>',
'imageUrl' => '<string>',
'mfaEnabled' => true,
'mfaSetup' => true,
'autoprovisioned' => true,
'scimStatus' => '<string>',
'automatedUser' => true,
'automatedUserFieldLabels' => [
'<string>'
],
'lastLogin' => [
'id' => '<string>',
'accessType' => '<string>'
],
'lastDeactivated' => '2023-11-07T05:31:56Z',
'external' => true,
'disabled' => true,
'serviceAccount' => true,
'superUser' => true,
'name' => '<string>',
'locked' => true
]
],
'currentValue' => [
'id' => '<string>',
'discriminator' => '<string>',
'idOrTransientId' => '<string>',
'transientIdOrId' => '<string>',
'textOrNumericValue' => '<string>',
'empty' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"recordDefault\": true,\n \"title\": \"<string>\",\n \"automatedUserGroup\": true,\n \"automatedUserGroupFieldLabel\": \"<string>\",\n \"users\": [\n {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"status\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true,\n \"email\": \"<string>\",\n \"company\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"mfaEnabled\": true,\n \"mfaSetup\": true,\n \"autoprovisioned\": true,\n \"scimStatus\": \"<string>\",\n \"automatedUser\": true,\n \"automatedUserFieldLabels\": [\n \"<string>\"\n ],\n \"lastLogin\": {\n \"id\": \"<string>\",\n \"accessType\": \"<string>\"\n },\n \"lastDeactivated\": \"2023-11-07T05:31:56Z\",\n \"external\": true,\n \"disabled\": true,\n \"serviceAccount\": true,\n \"superUser\": true,\n \"name\": \"<string>\",\n \"locked\": true\n }\n ],\n \"currentValue\": {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"recordDefault\": true,\n \"title\": \"<string>\",\n \"automatedUserGroup\": true,\n \"automatedUserGroupFieldLabel\": \"<string>\",\n \"users\": [\n {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"status\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true,\n \"email\": \"<string>\",\n \"company\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"mfaEnabled\": true,\n \"mfaSetup\": true,\n \"autoprovisioned\": true,\n \"scimStatus\": \"<string>\",\n \"automatedUser\": true,\n \"automatedUserFieldLabels\": [\n \"<string>\"\n ],\n \"lastLogin\": {\n \"id\": \"<string>\",\n \"accessType\": \"<string>\"\n },\n \"lastDeactivated\": \"2023-11-07T05:31:56Z\",\n \"external\": true,\n \"disabled\": true,\n \"serviceAccount\": true,\n \"superUser\": true,\n \"name\": \"<string>\",\n \"locked\": true\n }\n ],\n \"currentValue\": {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"recordDefault\": true,\n \"title\": \"<string>\",\n \"automatedUserGroup\": true,\n \"automatedUserGroupFieldLabel\": \"<string>\",\n \"users\": [\n {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"status\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true,\n \"email\": \"<string>\",\n \"company\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"mfaEnabled\": true,\n \"mfaSetup\": true,\n \"autoprovisioned\": true,\n \"scimStatus\": \"<string>\",\n \"automatedUser\": true,\n \"automatedUserFieldLabels\": [\n \"<string>\"\n ],\n \"lastLogin\": {\n \"id\": \"<string>\",\n \"accessType\": \"<string>\"\n },\n \"lastDeactivated\": \"2023-11-07T05:31:56Z\",\n \"external\": true,\n \"disabled\": true,\n \"serviceAccount\": true,\n \"superUser\": true,\n \"name\": \"<string>\",\n \"locked\": true\n }\n ],\n \"currentValue\": {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"recordDefault": true,
"title": "<string>",
"automatedUserGroup": true,
"automatedUserGroupFieldLabel": "<string>"
}User group
Update a user group
Adding new users to the user array will update user association to the user group.
PATCH
/
api
/
v1
/
userGroups
/
{userGroupId}
Update a user group.
curl --request PATCH \
--url https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"recordDefault": true,
"title": "<string>",
"automatedUserGroup": true,
"automatedUserGroupFieldLabel": "<string>",
"users": [
{
"id": "<string>",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true,
"email": "<string>",
"company": "<string>",
"imageUrl": "<string>",
"mfaEnabled": true,
"mfaSetup": true,
"autoprovisioned": true,
"scimStatus": "<string>",
"automatedUser": true,
"automatedUserFieldLabels": [
"<string>"
],
"lastLogin": {
"id": "<string>",
"accessType": "<string>"
},
"lastDeactivated": "2023-11-07T05:31:56Z",
"external": true,
"disabled": true,
"serviceAccount": true,
"superUser": true,
"name": "<string>",
"locked": true
}
],
"currentValue": {
"id": "<string>",
"discriminator": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": true
}
}
'import requests
url = "https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}"
payload = {
"id": "<string>",
"recordDefault": True,
"title": "<string>",
"automatedUserGroup": True,
"automatedUserGroupFieldLabel": "<string>",
"users": [
{
"id": "<string>",
"discriminator": "<string>",
"status": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": True,
"email": "<string>",
"company": "<string>",
"imageUrl": "<string>",
"mfaEnabled": True,
"mfaSetup": True,
"autoprovisioned": True,
"scimStatus": "<string>",
"automatedUser": True,
"automatedUserFieldLabels": ["<string>"],
"lastLogin": {
"id": "<string>",
"accessType": "<string>"
},
"lastDeactivated": "2023-11-07T05:31:56Z",
"external": True,
"disabled": True,
"serviceAccount": True,
"superUser": True,
"name": "<string>",
"locked": True
}
],
"currentValue": {
"id": "<string>",
"discriminator": "<string>",
"idOrTransientId": "<string>",
"transientIdOrId": "<string>",
"textOrNumericValue": "<string>",
"empty": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
recordDefault: true,
title: '<string>',
automatedUserGroup: true,
automatedUserGroupFieldLabel: '<string>',
users: [
{
id: '<string>',
discriminator: '<string>',
status: '<string>',
idOrTransientId: '<string>',
transientIdOrId: '<string>',
textOrNumericValue: '<string>',
empty: true,
email: '<string>',
company: '<string>',
imageUrl: '<string>',
mfaEnabled: true,
mfaSetup: true,
autoprovisioned: true,
scimStatus: '<string>',
automatedUser: true,
automatedUserFieldLabels: ['<string>'],
lastLogin: {id: '<string>', accessType: '<string>'},
lastDeactivated: '2023-11-07T05:31:56Z',
external: true,
disabled: true,
serviceAccount: true,
superUser: true,
name: '<string>',
locked: true
}
],
currentValue: {
id: '<string>',
discriminator: '<string>',
idOrTransientId: '<string>',
transientIdOrId: '<string>',
textOrNumericValue: '<string>',
empty: true
}
})
};
fetch('https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'recordDefault' => true,
'title' => '<string>',
'automatedUserGroup' => true,
'automatedUserGroupFieldLabel' => '<string>',
'users' => [
[
'id' => '<string>',
'discriminator' => '<string>',
'status' => '<string>',
'idOrTransientId' => '<string>',
'transientIdOrId' => '<string>',
'textOrNumericValue' => '<string>',
'empty' => true,
'email' => '<string>',
'company' => '<string>',
'imageUrl' => '<string>',
'mfaEnabled' => true,
'mfaSetup' => true,
'autoprovisioned' => true,
'scimStatus' => '<string>',
'automatedUser' => true,
'automatedUserFieldLabels' => [
'<string>'
],
'lastLogin' => [
'id' => '<string>',
'accessType' => '<string>'
],
'lastDeactivated' => '2023-11-07T05:31:56Z',
'external' => true,
'disabled' => true,
'serviceAccount' => true,
'superUser' => true,
'name' => '<string>',
'locked' => true
]
],
'currentValue' => [
'id' => '<string>',
'discriminator' => '<string>',
'idOrTransientId' => '<string>',
'transientIdOrId' => '<string>',
'textOrNumericValue' => '<string>',
'empty' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"recordDefault\": true,\n \"title\": \"<string>\",\n \"automatedUserGroup\": true,\n \"automatedUserGroupFieldLabel\": \"<string>\",\n \"users\": [\n {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"status\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true,\n \"email\": \"<string>\",\n \"company\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"mfaEnabled\": true,\n \"mfaSetup\": true,\n \"autoprovisioned\": true,\n \"scimStatus\": \"<string>\",\n \"automatedUser\": true,\n \"automatedUserFieldLabels\": [\n \"<string>\"\n ],\n \"lastLogin\": {\n \"id\": \"<string>\",\n \"accessType\": \"<string>\"\n },\n \"lastDeactivated\": \"2023-11-07T05:31:56Z\",\n \"external\": true,\n \"disabled\": true,\n \"serviceAccount\": true,\n \"superUser\": true,\n \"name\": \"<string>\",\n \"locked\": true\n }\n ],\n \"currentValue\": {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"recordDefault\": true,\n \"title\": \"<string>\",\n \"automatedUserGroup\": true,\n \"automatedUserGroupFieldLabel\": \"<string>\",\n \"users\": [\n {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"status\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true,\n \"email\": \"<string>\",\n \"company\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"mfaEnabled\": true,\n \"mfaSetup\": true,\n \"autoprovisioned\": true,\n \"scimStatus\": \"<string>\",\n \"automatedUser\": true,\n \"automatedUserFieldLabels\": [\n \"<string>\"\n ],\n \"lastLogin\": {\n \"id\": \"<string>\",\n \"accessType\": \"<string>\"\n },\n \"lastDeactivated\": \"2023-11-07T05:31:56Z\",\n \"external\": true,\n \"disabled\": true,\n \"serviceAccount\": true,\n \"superUser\": true,\n \"name\": \"<string>\",\n \"locked\": true\n }\n ],\n \"currentValue\": {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.logicgate.com/api/v1/userGroups/{userGroupId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"recordDefault\": true,\n \"title\": \"<string>\",\n \"automatedUserGroup\": true,\n \"automatedUserGroupFieldLabel\": \"<string>\",\n \"users\": [\n {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"status\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true,\n \"email\": \"<string>\",\n \"company\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"mfaEnabled\": true,\n \"mfaSetup\": true,\n \"autoprovisioned\": true,\n \"scimStatus\": \"<string>\",\n \"automatedUser\": true,\n \"automatedUserFieldLabels\": [\n \"<string>\"\n ],\n \"lastLogin\": {\n \"id\": \"<string>\",\n \"accessType\": \"<string>\"\n },\n \"lastDeactivated\": \"2023-11-07T05:31:56Z\",\n \"external\": true,\n \"disabled\": true,\n \"serviceAccount\": true,\n \"superUser\": true,\n \"name\": \"<string>\",\n \"locked\": true\n }\n ],\n \"currentValue\": {\n \"id\": \"<string>\",\n \"discriminator\": \"<string>\",\n \"idOrTransientId\": \"<string>\",\n \"transientIdOrId\": \"<string>\",\n \"textOrNumericValue\": \"<string>\",\n \"empty\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"recordDefault": true,
"title": "<string>",
"automatedUserGroup": true,
"automatedUserGroupFieldLabel": "<string>"
}Authorizations
ApiTokenbasic
Body
application/json

