Privileged users are able to define a persona that can be assigned to different users or groups based on their role. A persona object includes
-
A collection of pages that the user or group is able to access.
-
A default home page.
When defining a persona, users are able to select pages from different persona categories. As installed, there are a few predefined categories, and it is possible for user to add new categories and pages to them. Additionally, as installed, the system has a few predefined personas that are immutable; however, users are able to copy and customize them. There is one system-wide default persona, that is configurable. Deletion of default persona is not allowed. Default persona is used for users who have no persona assigned to them. A persona is assignable to both users and groups. A single user or group can have multiple personas assigned. * Persona: A persona is a specific role that can be assigned to one or more users, such as Release Manager. It defines the list of pages that a persona can view. * Persona Details: Details for a given persona: categories and pages visible to them. * Persona Categories: A persona category is a container for as set of child persona pages. * Persona Pages: Persona pages are those relevant to a given persona. They are organized into persona categories. * Persona Assignment: Personas are assigned to users and groups.
addPersonaDetail
Creates a new personaDetail
object. You must specify a personaName
and personaCategoryName
.
Arguments | Descriptions |
---|---|
personaName |
Existing persona name. |
personaCategoryName |
A valid persona category to create. Argument type: String |
personaPages |
(Optional) Specific set of pages to be added to this persona detail object. If this argument is not provided then the category and all pages under will be added to persona. Argument type: String |
Response
Returns a personaDetail object.
removePersonaDetail
Removes a personaDetail
object. You must specify a personaName
and personaCategoryName
.
Arguments | Descriptions |
---|---|
personaName |
Existing persona name. |
personaCategoryName |
A valid persona category to remove.
Argument type: String |
personaPages |
(Optional) Specific set of pages to be removed from this persona detail object. If this argument is not provided then the category and all pages under will be added to persona. Argument type: String |
Response
Returns a personaDetail object.
createPersona
Creates a new persona
object. You must specify a personaName
.
Arguments | Descriptions |
---|---|
personaName |
The persona name. Argument type: String |
personaDetails |
A JSON string providing the Argument type: String |
homePageName |
(Optional) Specify one of pages included in the If not specified, a home page is not defined for this persona. Argument: String |
description |
(Optional) User-defined comment text describing this object. Argument type: String |
isDefault |
(Optional) < Boolean flag — To set this object as the system-wide default persona, set to Argument Type: Boolean |
Response
Returns a persona object.
Below is an example on how to specify the value of the personaDetails
argument. It defines two persona categories, each with two persona pages (line breaks added for readability). The personaPages
specified under a given category must be valid for that category.
[{"personaCategory":"releaseorchestration", "personaPages":["pipeline","release"]}, {"personaCategory":"deployment", "personaPages":["application","environment"]}]
deletePersona
getPersona
Retrieves the specified persona. You must specify the personaName
object you wish to retrieve.
Arguments | Descriptions |
---|---|
personaName |
The name of the persona to retrieve. Argument type: String |
Response
Returns a persona object.
getPersonas
Retrieves persona objects subject to specified criteria sent with the request. If no parameter is specified, all personas in the system are returned, sorted by persona name.
Arguments | Descriptions |
---|---|
userName |
(Optional) Return all personas associated with this user, sorted by the timestamp when the persona was assigned to the user. Cannot be used with Argument type: string |
merged |
(Optional) If set to
Argument type: boolean |
excludeGroupPersonas |
(Optional)Whether to exclude personas associated with groups. Used with the
Argument type: boolean |
groupName |
(Optional) Return all personas associated with this group, sorted by |
Response
Returns zero or more persona objects.
modifyPersona
Modifies the specified persona object.
Arguments | Descriptions |
---|---|
personaName |
The persona name. Argument type: String |
clearDetails |
(Optional) < Boolean flag — If Argument type: Boolean |
personaDetails |
(Optional) A JSON string providing the Argument type: String |
homePageName |
(Optional) Specify one of pages included in the If not specified, a home page is not defined for this persona. Argument type: String |
description |
(Optional) User-defined comment text describing this object. Argument type: String |
isDefault |
(Optional) < Boolean flag — To set this object as the system-wide default persona, set to Argument type: Boolean |
newName |
(optional) The new name for this persona. Argument type: String |
Response
Returns a persona object.
createPersonaCategory
Creates a new personaCategory
object. Specify the name of the new page with personaCategoryName
.
Arguments | Descriptions |
---|---|
personaCategoryName |
The name of the new persona category. Argument type: String |
description |
(Optional) User-defined comment text describing this object. Argument type: String |
personaPages |
(Optional) One or more persona page names to add to this persona category. Use getPersonaPages for a list of currently defined pages. |
Response
Returns the new personaCategory object.
deletePersonaCategory
getPersonaCategory
Retrieves the specified personaCategory
object. You must specify the personaCategoryName
to retrieve.
Arguments | Descriptions |
---|---|
personaCategoryName |
The name of the persona category to retrieve. Use getpersonaCategorys to determine Argument type: String |
Response
Returns a personaCategory object.
getPersonaCategories
Retrieves all persona categories.
Arguments | Descriptions |
---|---|
None |
– |
Response
Returns a list of personaCategory objects.
modifyPersonaCategory
Modifies the specified personaCategory
object. You must specify a personaCategoryName
.
Arguments | Descriptions |
---|---|
personaCategoryName |
The persona category object to modify. Use getPersonaCategories to retrieve a list of existing categories. Argument type: String |
newName |
(Optional) New name for Argument type: String |
description |
(Optional) User-defined comment text describing this object. Argument type: String |
personaPages |
(Optional) Create one or more new persona pages if they don’t already exist in this category. Use getPersonaPages for a list of currently defined pages. |
clearPages |
(Optional) < Boolean flag — If Argument Type: Boolean |
Response
Returns the modified personaCategory object.
createPersonaPage
Creates a new personaPage
object.
Specify the name of the new page with personaPageName
.
Arguments | Descriptions |
---|---|
personaPageName |
The name of the new persona page. Argument type: String |
description |
(Optional) User-defined comment text describing this object. Argument type: String |
url |
(Optional) The persona page URL. Argument type: String |
Response
Returns the new personaPage object.
deletePersonaPage
getPersonaPage
Retrieves the specified personaPage
object.
You must specify the personaPageName
to retrieve.
Arguments | Descriptions |
---|---|
personaPageName |
The name of the persona page to retrieve. Use getPersonaPages to determine Argument type: String |
Response
Returns a personaPage object.
getPersonaPages
Retrieves all persona pages.
Arguments | Descriptions |
---|---|
None |
– |
Response
Returns a list of personaPage objects.
modifyPersonaPage
Modifies the specified personaPage
object. You must specify a personaPageName
.
Arguments | Descriptions |
---|---|
personaPageName |
The persona page name to modify. Argument type: String |
newName |
(Optional) New name for an existing Argument type: String |
description |
(Optional) User-defined comment text describing this object. Argument type: String |
url |
(Optional) The persona page URL. Argument type: String |
Response
Returns the modified personaPage object.
assignPersonaToUser
Assigns a list of valid users to an existing persona.
Arguments | Descriptions |
---|---|
personaName |
The persona name . Use getPersonas for a list of existing personas. Argument type: String |
userNames |
One or more user names to assign to Argument type: String |
Response
Returns the new user object.
unassignPersonaFromUser
Unassigns the specified list of users from the existing persona.
Arguments | Descriptions |
---|---|
personaName |
The persona name . Use getPersonas for a list of existing personas and user assignments. Argument type: String |
userNames |
One or more user names to unassign from Argument type: String |
Response
Returns the new user object.
assignPersonaToGroup
Assigns the specified list of groups to an existing persona.
Arguments | Descriptions |
---|---|
personaName |
The persona name . Use getPersonas for a list of existing personas. Argument type: String |
groupNames |
One or more group names to assign to Argument type: String |
Response
Returns the new group object.
unassignPersonaFromGroup
Unassigns the specified groups from the specified persona.
Arguments | Descriptions |
---|---|
personaName |
The persona name . Use getPersonas for a list of existing personas. Argument type: String |
groupNames |
One or more group names to assign to Argument type: String |
Response
Returns the new group object.