{
    "description": "All permissions in WebAdMIT cascade from the concept of a **user identity**.",
    "links": [
        {
            "description": "Retrieve details on all user identities that are part of a user's WebAdMIT profile and that have the \"API Access\" permission assigned to them.  The `id` associated with each identity will not change, and only becomes something new when a new identity is created \u2013 for example at the start of a new academic cycle.",
            "href": "/api/v1/user_identities",
            "http_header": {
                "x-api-key": "0123456789abcdef0123456789abcdef"
            },
            "method": "GET",
            "rel": "self",
            "title": "List"
        }
    ],
    "properties": {
        "href": {
            "description": "Hypertext reference to this resource.",
            "example": "/api/v1/user_identities",
            "pattern": "/api/v1/user_identities",
            "type": "string"
        },
        "user_identities": {
            "items": {
                "properties": {
                    "association": {
                        "description": "Human-readable name of the association that this user identity belongs to, or `null` if not applicable.",
                        "example": "SOPHAS",
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "cycle": {
                        "description": "Academic cycle that this user identity can access, or `null` if not applicable.",
                        "example": "2014 - 2015",
                        "pattern": "^\\d{4} - \\d{4}$",
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "id": {
                        "description": "Unique identifier for this user identity.",
                        "type": "integer"
                    },
                    "institution": {
                        "description": "Human-readable name of the institution that this user identity belongs to, or `null` if not applicable.",
                        "example": "Demo University",
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "organization": {
                        "description": "Human-readable name of the organization that this user identity belongs to, or `null` if not applicable.",
                        "example": "Demo University School of Public Health",
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "type": {
                        "description": "Type of access granted by this user identity.",
                        "enum": [
                            "Admissions User",
                            "Association User",
                            "Institution User"
                        ],
                        "example": "Admissions User",
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "type": "array"
        }
    },
    "strictProperties": true,
    "title": "User Identity",
    "type": "object"
}