Get Auth Context

Get Auth Context

Retrieve the logged in user's auth context

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/rbac-service/api/auth-context
COPY
Query Parameters
boolean
excludeSupervisorRoleProjects
Optional
Constraints: default: true

Filters projects based on the supervisor role. When this filter is true it will not include the projects in which the current user is having only supervisor role

boolean
includeGroups
Optional
Constraints: default: false

Include Group information. When the flag is true it will include all the groups that has been added to the project and the user is a part of.

boolean
includeProjects
Optional
Constraints: default: true

Include Projects information. When the flag is true it will include project informationfor the user

string
apiVersion
Optional
Constraints: default: 2020-08-10

apiVersion

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with the auth context

Returns AuthContext of type(s) */* 
{
    "userRoles": [
        "string"
    ],
    "userPermissions": [
        "string"
    ],
    "projects": [
        {
            "projectId": "string",
            "projectName": "string",
            "userRoles": [
                "string"
            ],
            "userPermissions": [
                "string"
            ],
            "sharedResources": false,
            "groups": [
                {
                    "id": "c493a95e-c4d1-4496-8595-e73902701c95:fe69d7ca-40a6-4de5-8f33-d462f4656938",
                    "displayName": "[email protected]",
                    "groupType": "AD_GROUP, USER_GROUP",
                    "domain": "vmware.com",
                    "usersCount": 1
                }
            ]
        }
    ],
    "id": "string",
    "name": "string"
}
array of string
userRoles
Optional

A list of roles that the user has at organization level

array of string
userPermissions
Optional

A list of permissions that the user has at organization level

array of object
projects
Optional

A list of projects this user is a member of

string
id
Optional

Principal id of the user

string
name
Optional

Principal name of the user


401

Unauthorized, the user is not authenticated

Operation doesn't return any data structure

403

Forbidden, the user lacks permissions

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/rbac-service/api/auth-context
On This Page
User Auth Context Operations
GET
Get Auth Context