Documentation forAccess Rights Manager

Cockpit APIs

Get Cockpit Data (GET)

Returns cockpit data for the current user including overview statistics and personalized information.

Route

URI

/api/v1/Cockpit

Method

GET

Result

JSON – CockpitData

Parameters

None

Response Structure

Returns CockpitData object containing:

  • AccountManageActions: ScenarioActionDefinition [] value

  • GroupMembershipActions: [] value

  • ServiceActions: ScenarioActionDefinition [] value

  • SelfServiceActions: ScenarioActionDefinition [] value

  • RiskAssessmentResultNotifications: ScenarioInfo [] value

  • CockpitOptions: Contains information about which options, bubbles, etc., are available or visible.

  • MyContacts: ScenarioActionDefinition [] value

  • MyEmployees: Optional employee scenario value

Example

GET http://localhost/api/v1/Cockpit

Example Response

{
  "AccountManageActions": {},
  "GroupMembershipActions": {},
  "ServiceActions": {},
  "MyEmployees": {},
  "SelfServiceActions": {},
  "RiskAssessmentResultNotifications": {},
  "CockpitOptions": {}
  "MyContacts": {},
  "GroupMembershipActionsOnContacts": {}
}

Get My Personal Account Information (GET)

Returns personal account information for the currently logged-in user.

Route

URI

/api/v1/Cockpit/MyPersonalAccountInformation

Method

GET

Result

JSON – PersonalAccountInformation

Parameters

None

Response Structure

PersonalAccountInformation containing:

  • FirstnameLabel: string value
  • Firstname: string value
  • SurnameLabel: string value
  • Surname: string value
  • JobTitleLabel: string value
  • JobTitle: string value
  • CompanyLabel: string value
  • Company: string value
  • DepartmentLabel: string value
  • Department: string value
  • MailLabel: string value
  • Mail: string value
  • PhoneLabel: string value
  • Phone: string value
  • Photo (base64 encoded)

Example

GET http://localhost/api/v1/Cockpit/MyPersonalAccountInformation

Example Response

{
  "FirstnameLabel": "sample",
  "Firstname": "sample",
  "SurnameLabel": "sample",
  "Surname": "sample",
  "JobTitleLabel": "sample",
  "JobTitle": "sample",
  "CompanyLabel": "sample",
  "Company": "sample",
  "DepartmentLabel": "sample",
  "Department": "sample",
  "MailLabel": "sample",
  "Mail": "sample",
  "PhoneLabel": "sample",
  "Phone": "sample",
  "Photo": "sample
}

Get Personal Account Information (GET)

Returns personal account information for a specific account.

Route

URI

/api/v1/Cockpit/PersonalAccountInformation

Method

GET

Result

JSON – PersonalAccountInformation

Parameters

Name

Type

Mandatory

accountId

Guid

No

provider

string

No

Response Structure PersonalAccountInformation containing:

  • FirstnameLabel: string value
  • Firstname: string value
  • SurnameLabel: string value
  • Surname: string value
  • JobTitleLabel: string value
  • JobTitle: string value
  • CompanyLabel: string value
  • Company: string value
  • DepartmentLabel: string value
  • Department: string value
  • MailLabel: string value
  • Mail: string value
  • PhoneLabel: string value
  • Phone: string value
  • Photo: string value

Example

GET http://localhost/api/v1/Cockpit/PersonalAccountInformation?accountId=123e4567-e89b-12d3-a456-426614174000&provider=AD

Example Response

{
    "firstnameLabel": "sample",
    "firstname": "sample",
    "surnameLabel": "sample",
    "surname": "sample",
    "jobTitleLabel": "sample",
    "jobTitle": "sample",
    "companyLabel": "sample",
    "company": "sample",
    "departmentLabel": "sample",
    "department": "sample",
    "mailLabel": "sample",
    "mail": "sample",
    "phoneLabel": "sample",
    "phone": "sample",
    "photo": "sample"
}

Get Common Personal Account Information (POST)

Returns the personal account information that is common to all provided account grid entries.

Route

URI

/api/v1/Cockpit/CommonPersonalAccountInformation

Method

POST

Result

JSON – PersonalAccountInformation

Parameters

Name

Type

Mandatory

webApplication

webApplication

No

Response Structure

PersonalAccountInformation containing:

  • FirstnameLabel: string value
  • Firstname: string value
  • SurnameLabel: string value
  • Surname: string value
  • JobTitleLabel: string value
  • JobTitle: string value
  • CompanyLabel: string value
  • Company: string value
  • DepartmentLabel: string value
  • Department: string value
  • MailLabel: string value
  • Mail: string value
  • PhoneLabel: string value
  • Phone: string value
  • Photo: string value

Example Request

POST http://localhost/api/v1/Cockpit/CommonPersonalAccountInformation

Example Response

{
"FirstnameLabel": "sample",
"Firstname": "sample",
"SurnameLabel": "sample",
"Surname": "sample",
"JobTitleLabel": "sample",
"JobTitle": "sample",
"CompanyLabel": "sample",
"Company": "sample",
"DepartmentLabel": "sample",
"Department": "sample",
"MailLabel": "sample",
"Mail": "sample",
"PhoneLabel": "sample",
"Phone": "sample",
"Photo": "sample"
}