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: Available account management actions

  • GroupMembershipActions: Available group membership actions

  • ServiceActions: Available service actions

  • SelfServiceActions: Self-service actions

  • RiskAssessmentResultNotifications: Risk assessment information

  • CockpitOptions: Configuration options

  • MyContacts: Contact actions

  • MyEmployees: Optional employee scenario

Example

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

Example Response

{
  "AccountManageActions": [],
  "GroupMembershipActions": [],
  "ServiceActions": [],
  "MyEmployees": null,
  "SelfServiceActions": [],
  "RiskAssessmentResultNotifications": [],
  "CockpitOptions": {
    "ShowMyEmployees": true,
    "ShowRiskAssessment": true
  },
  "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

Returns PersonalAccountInformation object with properties:

  • Firstname, FirstnameLabel

  • Surname, SurnameLabel

  • JobTitle, JobTitleLabel

  • Company, CompanyLabel

  • Department, DepartmentLabel

  • Mail, MailLabel

  • Phone, PhoneLabel

  • Photo (base64 encoded)

Example

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

Example Response

{
  "FirstnameLabel": "First Name",
  "Firstname": "John",
  "SurnameLabel": "Last Name",
  "Surname": "Doe",
  "JobTitleLabel": "Job Title",
  "JobTitle": "Software Engineer",
  "CompanyLabel": "Company",
  "Company": "Acme Corp",
  "DepartmentLabel": "Department",
  "Department": "IT",
  "MailLabel": "Email",
  "Mail": "john.doe@acme.com",
  "PhoneLabel": "Phone",
  "Phone": "+1-555-0100",
  "Photo": null
}

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

Description

accountId

Guid

Yes

The unique identifier of the account

provider

string

Yes

The provider identifier

Example

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

Example Response

{
    "Type": "BC991514-FBAF-4BE6-BBE4-D0B8E0032CDB",
    "firstnameLabel": null,
    "firstname": null,
    "surnameLabel": null,
    "surname": null,
    "jobTitleLabel": null,
    "jobTitle": null,
    "companyLabel": "Company",
    "company": "Solarwinds",
    "departmentLabel": "Department",
    "department": "Solarwinds",
    "mailLabel": null,
    "mail": null,
    "phoneLabel": null,
    "phone": null,
    "photo": "iVBORw0KGg"
}

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

Request Payload

Array of account grid entry objects.

Response Structure

Returns PersonalAccountInformation with common properties across all provided accounts.

Example Request

POST http://localhost/api/v1/Cockpit/CommonPersonalAccountInformation
Content-Type: application/json

[
  {
    "AccountId": "123e4567-e89b-12d3-a456-426614174001",
    "Provider": "AD",
    "DisplayName": "John Doe"
  },
  {
    "AccountId": "123e4567-e89b-12d3-a456-426614174002",
    "Provider": "AD",
    "DisplayName": "Jane Smith"
  }
]

Example Response

{
  "CompanyLabel": "Company",
  "Company": "Contoso",
  "DepartmentLabel": "Department",
  "Department": "IT"
}