PUT api/UserGroups/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
Body Parameters
PermissionGroup| Name | Description | Type | Additional information |
|---|---|---|---|
| Claims | Collection of PermissionClaim |
None. |
|
| InstitutionIdentity | globally unique identifier |
None. |
|
| IsSystemGroup | boolean |
None. |
|
| IsAdminGroup | boolean |
None. |
|
| Scopes | Collection of ScopeType |
None. |
|
| EditClaimsPermissionGroups | Collection of PermissionObject |
None. |
|
| CanEditClaims | boolean |
None. |
|
| Identity | globally unique identifier |
None. |
|
| Name | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Claims": [
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
}
],
"InstitutionIdentity": "ed3bf085-b2a7-43ac-b739-3ef59600db52",
"IsSystemGroup": true,
"IsAdminGroup": true,
"Scopes": [
0,
0
],
"EditClaimsPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "b6c02bad-c5d2-4d5a-b702-363d8b27fb08",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "b6c02bad-c5d2-4d5a-b702-363d8b27fb08",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "5643306e-def3-4d62-9114-942e21530284",
"Name": "sample string 6"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PermissionGroup| Name | Description | Type | Additional information |
|---|---|---|---|
| Claims | Collection of PermissionClaim |
None. |
|
| InstitutionIdentity | globally unique identifier |
None. |
|
| IsSystemGroup | boolean |
None. |
|
| IsAdminGroup | boolean |
None. |
|
| Scopes | Collection of ScopeType |
None. |
|
| EditClaimsPermissionGroups | Collection of PermissionObject |
None. |
|
| CanEditClaims | boolean |
None. |
|
| Identity | globally unique identifier |
None. |
|
| Name | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Claims": [
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
{
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
}
],
"InstitutionIdentity": "0b1933da-05b1-4718-944c-e45c05e5cda3",
"IsSystemGroup": true,
"IsAdminGroup": true,
"Scopes": [
0,
0
],
"EditClaimsPermissionGroups": [
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "f83f1b5d-e697-49b9-9ab3-8d2e692c4cd8",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "f83f1b5d-e697-49b9-9ab3-8d2e692c4cd8",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "5392e875-fe3c-456a-9c6e-c79189f4ccb9",
"Name": "sample string 6"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.