Get All Portals Accessible To User

Overview

The Get All Portals Accessible to User API allows a user to fetch all portals accessible to user across all department.

  • If no access tags are specified for a portal, then any user can access the portal.
  • If access tags are specified for a portal, users with a user profile that allows access 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.
  • All the global users(partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.
  • The only articles returned are associated to an Article type when the parameter, “Include in browse on portals” is set to "Yes".
  • 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 is returned in the response.
  • When there is no short URL available for a specific language, the API returns a portal object with an empty "shortURL" field.
SecurityoAuthUser or oAuthOnBehalfOfUser
Request
query Parameters
$lang
required
string

The language used for fetching the details of a resource. Resources available in different languages may differ from each other.

Enum: "en-US" "fr-FR" "en-GB" "es-ES" "it-IT" "nl-NL" "da-DA" "sv-SE" "pt-PT" "fi-FI" "no-NB" "no-NN" "ja-JA" "de-DE" "pt-BR" "zh-CN" "zh-TW" "ko-KO" "ru-RU" "el-EL" "tr-TR" "pl-PL" "cs-CS" "sk-SK" "hu-HU" "sr-SR" "ar-SA" "hr-HR" "ro-RO" "th-TH" "de-AT" "vi-VN" "id-ID" "ms-MY" "fil-PH" "fr-CA" "hi-IN" "uk-UA" "bg-BG" "sl-SI" "sr-RS" "xx-XX"
Example: $lang=en-US
department
string [ 0 .. 255 ] characters ^[\w\W]+$

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

Example: department=service
filterText
string [ 0 .. 255 ] characters ^[\w\W]+$

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

Example: filterText=master
shortUrlTemplate
string [ 0 .. 255 ] characters ^[\w\W]+$

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
integer <int64> [ 1 .. 999 ]
Default: 1

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

$pagesize
integer <int64> [ 1 .. 75 ]
Default: 25

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

header Parameters
Accept-Language
required
string

The Language locale accepted by the 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"
Example: en-US
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 default, shortURL only contains single object


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