POST api/UserGroups
Request Information
URI Parameters
None.
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": "32814433-f275-45cb-b344-e8c8c48e7c53",
"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": "6f4656c2-8d78-4b57-adfe-a64e684dda2e",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "6f4656c2-8d78-4b57-adfe-a64e684dda2e",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "9b7fbd74-1f3b-43fd-8224-a0ae8dff50de",
"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": "855b9406-c91f-4039-b750-70eb8d908e5c",
"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": "e28b57c7-ae41-4086-8a49-87a691b4fda2",
"Name": "sample string 2"
},
{
"PermissionClaim": {
"ClaimType": "sample string 1",
"ClaimValue": "sample string 2",
"ClaimTypeLower": "sample string 1",
"ClaimValueLower": "sample string 2"
},
"Identity": "e28b57c7-ae41-4086-8a49-87a691b4fda2",
"Name": "sample string 2"
}
],
"CanEditClaims": true,
"Identity": "fb18b8a5-eb6e-49c1-a09e-807bfea436d8",
"Name": "sample string 6"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.