targetprocess-authorization v0.5.1

targetprocess-authorization

Installation and Usage

Prerequisites: Node.js (>=6.0.0), npm version 3+.

There are two ways to install: globally and locally.

Local Installation and Usage

$ npm install targetprocess-authorization

You should then run any of the tools provided like this:

$ ./node_modules/.bin/authorization-show ...

Global Installation and Usage

If you want targetprocess-authorization to be available globally, do so using npm:

$ npm install -g targetprocess-authorization

You should then run any of the tools provided like this:

$ authorization-show ...

Command Line Tools

• authorization-show shows under which role a user is assigned to a project.
• authorization-assign assigns a user to a project with the specified role.
• authorization-unassign unassigns a user from a project.

If you want more details about one of these tools, use the help option. For instance:

$ authorization-show --help

How To

Show

• Show under which role a user is assigned to a project, knowing user and project id.

  $ authorization-show -d mycompany.tpondemand.com -t <token> -u 123 -p 456

• Show under which role a user is assigned to a project, without knowing any id.
  You may use the name instead of the id (last name for users).

  $ authorization-show -d mycompany.tpondemand.com -t <token> -u Spielberg -p "Indiana Jones"

• Show the list of all users assigned to one particular project.
  (Do not specify the user in this case.)

  $ authorization-show -d mycompany.tpondemand.com -t <token> -p "Indiana Jones"

Unassign

• Unassign a person from all projects.

  $ authorization-unassign -d mycompany.tpondemand.com -t <token> -u "Spielberg"

• Unassign everyon from the projects matching given filter.

  $ authorization-unassign -d mycompany.tpondemand.com -t <token> -p "where=(IsProduct eq 'true')"

Assign

• Assign all active users to one particular project with the specified role.
  (If you don't specify the user, the project is assigned to all active users.)

  $ authorization-assign -d mycompany.tpondemand.com -t <token> -p "Indiana Jones" -r actor

• Assign all active users to one particular project with their default role.
  (If you don't specify the role, the default role of the user is used.)

  $ authorization-assign -d mycompany.tpondemand.com -t <token> -p "Indiana Jones"

• Assign a user to all active projects with the specified role.
  (If you don't specify the project, the user is assigned to all active projects.)

  $ authorization-assign -d mycompany.tpondemand.com -t <token> -u Spielberg -r director

• Assign all users to the projects matching given filter with the specified role.
  See Filters for more details on filtering conditions.

  $ authorization-assign -d mycompany.tpondemand.com -t <token> -p "where=(IsProduct eq 'true')" -r PO

Filters

Filtering conditions must be specified using Targetprocess API syntax.

Quick summary:

• The operator and is case-sensitive, so it has to be in lower case (e.g. AND or And will not work).
• In order to combine several rules you have to use logical grouping with brackets (ie "(" and ")").
• The operator or is not supported.
• Use single quotes to enclose non-numeric values.
• Escaping of single quote symbol in values can be done using preceding backslash: where=Name contains '\''