[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Update Service Roles For Multiple Users

Description

Updates the service roles of users in an organization.

Request

Request

URL

URL


patch
https://{api_host}/v1/orgs/{orgId}/users-service-roles
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


Query Parameters

Query Parameters

string
context Optional

context can be OPERATOR, PROVIDER or TENANT.


Request Body

Request Body

UserServiceRolesItemForAuth of mimetype application/json Optional
{
    "UserServiceRolesItemForAuth": {
        "serviceRolesItems": [
            {
                "roleNamesToAdd": [
                    "...",
                    "..."
                ],
                "roleNamesToRemove": [
                    "...",
                    "..."
                ],
                "serviceId": "..."
            },
            {
                "roleNamesToAdd": [
                    "...",
                    "..."
                ],
                "roleNamesToRemove": [
                    "...",
                    "..."
                ],
                "serviceId": "..."
            }
        ],
        "users": [
            "...",
            "..."
        ]
    },
    "serviceRolesItems": [
        {
            "roleNamesToAdd": [
                "...",
                "..."
            ],
            "roleNamesToRemove": [
                "...",
                "..."
            ],
            "serviceId": "..."
        },
        {
            "roleNamesToAdd": [
                "...",
                "..."
            ],
            "roleNamesToRemove": [
                "...",
                "..."
            ],
            "serviceId": "..."
        }
    ],
    "users": [
        "...",
        "..."
    ]
}
serviceRolesItems Optional

The list of service role objects.


array of string
users Optional

The list of users.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns array of UserServiceRolesForAuth of type application/json
{
	"serviceRoles": [
		{
			"resourceTypes": [
				"string"
			],
			"resources": [
				{
					"id": "string",
					"name": "string"
				}
			],
			"roles": [
				{
					"associatedResources": [
						"string"
					],
					"defaultRole": false,
					"displayName": "string",
					"enabled": false,
					"hidden": false,
					"memberType": "DIRECT",
					"mspDefaultRole": false,
					"mspDefaultRoleOfProviderAtTenant": false,
					"name": "string",
					"resource": "string",
					"roleId": "string",
					"status": "string"
				}
			],
			"serviceDisplayName": "string",
			"serviceId": "string"
		}
	],
	"user": {}
}
array of ServiceRoles
serviceRoles Optional

The list of service role objects.


user Optional

Defines the properties of User Details.

Errors

Errors

401

Unauthorized - The user is not authorized to use the API


500

Internal Server Error - An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"UserServiceRolesItemForAuth":{"serviceRolesItems":[{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."],"serviceId":"..."},{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."],"serviceId":"..."}],"users":["...","..."]},"serviceRolesItems":[{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."],"serviceId":"..."},{"roleNamesToAdd":["...","..."],"roleNamesToRemove":["...","..."],"serviceId":"..."}],"users":["...","..."]}' https://{api_host}/v1/orgs/{orgId}/users-service-roles
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: body


Feedback

Was this page helpful?