POST api/UserGroups

Request Information

URI Parameters

None.

Body Parameters

PermissionGroup
NameDescriptionTypeAdditional 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": "5d5b5a7e-dffb-4319-a3ba-524cf76f73e9",
  "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": "c0d8852f-5181-4e1e-9631-719d52f92298",
      "Name": "sample string 2"
    },
    {
      "PermissionClaim": {
        "ClaimType": "sample string 1",
        "ClaimValue": "sample string 2",
        "ClaimTypeLower": "sample string 1",
        "ClaimValueLower": "sample string 2"
      },
      "Identity": "c0d8852f-5181-4e1e-9631-719d52f92298",
      "Name": "sample string 2"
    }
  ],
  "CanEditClaims": true,
  "Identity": "8a05e38e-47a5-4280-88d8-0e1363138178",
  "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
NameDescriptionTypeAdditional 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": "a388443d-66b3-4b8e-b2d5-91560d60b844",
  "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": "a0c8346c-e7a6-4f02-b97c-3b330e32f6f9",
      "Name": "sample string 2"
    },
    {
      "PermissionClaim": {
        "ClaimType": "sample string 1",
        "ClaimValue": "sample string 2",
        "ClaimTypeLower": "sample string 1",
        "ClaimValueLower": "sample string 2"
      },
      "Identity": "a0c8346c-e7a6-4f02-b97c-3b330e32f6f9",
      "Name": "sample string 2"
    }
  ],
  "CanEditClaims": true,
  "Identity": "9f871d5e-9a51-400a-9d27-04c71c872ae5",
  "Name": "sample string 6"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.