Sync Projects Principals

Sync principals assigned to any project within user organization

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/project-service/api/projects/{id}/sync-principals

COPY

Path Parameters

string

Required

The id of the project.

Query Parameters

string

apiVersion

Optional

Constraints: default: 2019-01-15

The version of the API in yyyy-MM-dd format. For versioning information refer to /project-service/api/about.

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

'Success'

Returns PrincipalRole of type(s) */*

{
    "id": "c493a95e-c4d1-4496-8595-e73902701c95:fe69d7ca-40a6-4de5-8f33-d462f4656938",
    "email": "[email protected]",
    "type": "user",
    "role": "member"
}

string

Optional

ID of the user or id of the group in CSP

string

Required

The username of the user or display name of the group. When assigning a group, the email is expected to have the format displayName@domain. In the case where the display name in Identity provider is in the format:

name@domain - email should be written as name@domain@domain

name (and group has domain) - email should be written as name@domain

name (and group doesn't have domain) - email should be written as name@

to ensure proper functioning.

string

type

Optional

Type of the principal. Currently supported 'user' (default) and 'group'.

string

role

Optional

Role of this member. Currently supported 'member', 'viewer', 'administrator', 'supervisor'.

403

Forbidden, the user lacks permissions

Operation doesn't return any data structure

404

'Not found' if no project with the provided id

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' https://{api_host}/project-service/api/projects/{id}/sync-principals

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Project Operations

POST

Sync Projects Principals

Modify Project Principals