{
"title": "result",
"type": "object",
"properties": {
"id": {
"$ref": "common-schema#/definitions/objectId",
"description": "The accountId for the logged in user"
},
"provenance": {
"type": "string",
"description": "The name of the AAA adapter from which the user logged in",
"examples": [
"Local AAA"
]
},
"username": {
"type": "string",
"description": "The username of the logged in user",
"examples": [
"jane_doe"
]
},
"firstname": {
"type": "string",
"description": "The first name of the logged in user",
"examples": [
"Jane"
]
},
"groups": {
"type": "array",
"description": "An array of groups which contain the logged in user",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "common-schema#/definitions/objectId"
},
"provenance": {
"type": "string",
"description": "The name of the AAA adapter which contains the group",
"examples": [
"Local AAA"
]
},
"name": {
"type": "string",
"description": "The name of the group",
"examples": [
"admin_group"
]
}
}
}
},
"roles": {
"type": "array",
"description": "Array of roles user has access to",
"items": {
"$ref": "common-schema#/definitions/objectId"
}
},
"roleNames": {
"type": "array",
"description": "Array of role names user has access to",
"items": {
"type": "string"
}
},
"allowedMethods": {
"type": "array",
"description": "The API methods which a user has access to",
"items": {
"type": "object",
"properties": {
"provenance": {
"type": "string",
"description": "The service which contains the method",
"examples": [
"AutomationStudio"
]
},
"name": {
"type": "string",
"description": "The name of the method",
"examples": [
"getTemplates"
]
}
}
}
},
"allowedViews": {
"type": "array",
"description": "The URL pages which a user has access to",
"items": {
"type": "object",
"properties": {
"provenance": {
"type": "string",
"description": "The service which contains the view",
"examples": [
"AutomationStudio"
]
},
"path": {
"type": "string",
"description": "The URL route to the view",
"examples": [
"/automation-studio/"
]
}
}
}
},
"routes": {
"type": "array",
"description": "Array of routes logged in user has access to",
"items": {
"type": "string",
"examples": [
"/admin/"
]
}
}
}
}