GET api/UserGroups/NamedObjects?includeEveryoneGroup={includeEveryoneGroup}

Request Information

URI Parameters

Name	Description	Type	Additional information
includeEveryoneGroup		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of PermissionGroup

Name	Type	Additional information
Claims	Collection of PermissionClaim	None.
InstitutionIdentity	globally unique identifier	None.
IsSystemGroup	boolean	None.
IsAdminGroup	boolean	None.
Scopes	Collection of ScopeType	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"
      },
      {
        "ClaimType": "sample string 1",
        "ClaimValue": "sample string 2"
      }
    ],
    "InstitutionIdentity": "6a27b0e4-dba3-4f18-94ed-ecca0ddfdb99",
    "IsSystemGroup": true,
    "IsAdminGroup": true,
    "Scopes": [
      0,
      0
    ],
    "Identity": "d95d27ec-214b-446b-ab08-01bf519e1e45",
    "Name": "sample string 5"
  },
  {
    "Claims": [
      {
        "ClaimType": "sample string 1",
        "ClaimValue": "sample string 2"
      },
      {
        "ClaimType": "sample string 1",
        "ClaimValue": "sample string 2"
      }
    ],
    "InstitutionIdentity": "6a27b0e4-dba3-4f18-94ed-ecca0ddfdb99",
    "IsSystemGroup": true,
    "IsAdminGroup": true,
    "Scopes": [
      0,
      0
    ],
    "Identity": "d95d27ec-214b-446b-ab08-01bf519e1e45",
    "Name": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPermissionGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <PermissionGroup>
    <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">d95d27ec-214b-446b-ab08-01bf519e1e45</Identity>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 5</Name>
    <Claims xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ToDoModels">
      <d3p1:PermissionClaim>
        <d3p1:ClaimType>sample string 1</d3p1:ClaimType>
        <d3p1:ClaimValue>sample string 2</d3p1:ClaimValue>
      </d3p1:PermissionClaim>
      <d3p1:PermissionClaim>
        <d3p1:ClaimType>sample string 1</d3p1:ClaimType>
        <d3p1:ClaimValue>sample string 2</d3p1:ClaimValue>
      </d3p1:PermissionClaim>
    </Claims>
    <InstitutionIdentity>6a27b0e4-dba3-4f18-94ed-ecca0ddfdb99</InstitutionIdentity>
    <IsAdminGroup>true</IsAdminGroup>
    <IsSystemGroup>true</IsSystemGroup>
    <Scopes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:ScopeType>RB</d3p1:ScopeType>
      <d3p1:ScopeType>RB</d3p1:ScopeType>
    </Scopes>
  </PermissionGroup>
  <PermissionGroup>
    <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">d95d27ec-214b-446b-ab08-01bf519e1e45</Identity>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 5</Name>
    <Claims xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ToDoModels">
      <d3p1:PermissionClaim>
        <d3p1:ClaimType>sample string 1</d3p1:ClaimType>
        <d3p1:ClaimValue>sample string 2</d3p1:ClaimValue>
      </d3p1:PermissionClaim>
      <d3p1:PermissionClaim>
        <d3p1:ClaimType>sample string 1</d3p1:ClaimType>
        <d3p1:ClaimValue>sample string 2</d3p1:ClaimValue>
      </d3p1:PermissionClaim>
    </Claims>
    <InstitutionIdentity>6a27b0e4-dba3-4f18-94ed-ecca0ddfdb99</InstitutionIdentity>
    <IsAdminGroup>true</IsAdminGroup>
    <IsSystemGroup>true</IsSystemGroup>
    <Scopes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
      <d3p1:ScopeType>RB</d3p1:ScopeType>
      <d3p1:ScopeType>RB</d3p1:ScopeType>
    </Scopes>
  </PermissionGroup>
</ArrayOfPermissionGroup>