Get All Portals Accessible To User

Overview

This API allows a user to fetch all portals accessible to user across all department.

Functional Behavior

  1. If no access tags are specified for a portal, any user can access the portal.
  2. If access tags are specified for a portal, users with a user profile that allows access will have access to the portal. For users with multiple user profiles, the user profile that allows access does not need to be the active user profile.
  3. All the global users(partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.
  4. Portal default Short URL will be returned in the response if "shortUrlTemplate" query parameter is not provided
  5. When the "shortUrlTemplate" query parameter is provided, the API filters accessible portals according to the specified language and template name. Portal Short URL specific to to the "shortUrlTemplate" query parameter value will be returned in the response.
  6. When there is no short URL available for a specific language, the API will return a portal object with an empty "shortURL" field.
SecurityoAuthUser
Request
query Parameters
$lang
required
string

The knowledge base language used for retrieving response. Must be a language accessible to user.

Enum: "en-US" "en-GB" "fr-FR" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "sv-SE" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR"
Example: $lang=en-US
department
string

The Name of the department for which portals are to be fetched

Example: department=service
filterText
string

Portal name starting with a specific character are considered to filter the result.

Example: filterText=master
shortUrlTemplate
string

The Name of the template used while creating Short URL.

Example: shortUrlTemplate=silver
$sort
string

Objects returned in server response are sorted based on the attribute supplied under $sort.
Default value: name.

Enum: "id" "name" "departmentName"
$order
string

Common query parameter $order.

Enum: "asc" "desc"
$pagenum
string

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
Default value: 1

$pagesize
string

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
Default value: 25

header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

Success

204

No Content If all the portals are personalized and user does not have any profile assigned

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/myportals
Request samples
Response samples
application/json
By defualt shortURL only contains single object


{
  • "portal": [
    ],
  • "paginationInfo": {
    }
}