get-groups

Specification Version

Version: "1"

Context and rules

Required for the SubjectRead capability.

Returns details of groups, including the keys of the structural entities which are assigned to them, when an array of group keys is passed in.

The structural entity keys returned should be compatible with the get-structural-entities endpoint.

Endpoint specification

• Name: endpoint-prefix-aireframe-get-groups
• Verb: POST
• Authentication: Client credentials

Input

• Format: JSON
• Schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "get-groups-input",
	"type": "object",
    "required": [
		"Keys"
	],
	"properties": {
		"Keys": {
			"type": "array",
			"items": {
				"type": "string"
			}
		}
	}	
}

• Example:

{
	"Keys": [
		"admin"
	]
}

Response

• Format: JSON
• Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "get-groups-response",
  "type": "object",
  "required": [
    "Groups"
  ],
  "properties": {
    "Groups": {
      "type": "array",
      "items": {
        "Group": {
            "type": "object",
            "properties": {
                "Key": {
                    "type": "string"
                },
                "DisplayName": {
                    "type": "string"
                },
                "StructuralEntityKeys": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "required": [
                "Key",
                "DisplayName",
                "StructuralEntityKeys"
            ]
        }
      }
    }
  }
}

• Example

{
	"Groups": [
		{
			"Key": "admin",
			"DisplayName": "Admin",
			"StructuralEntityKeys": [
				"AAA",
				"AAB",
				"AAC"
			]
		}
	]
}

Previous versions

None