Share via

Accounts - Add Root Collection Admin

Service:
Purview
API Version:
2021-12-01

Add the administrator for root collection associated with this account.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/addRootCollectionAdmin?api-version=2021-12-01

URI Parameters

Name In Required Type Description
accountName
 path True

string

minLength: 3
maxLength: 63
pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

The name of the account.
resourceGroupName
 path True

string

The resource group name.
subscriptionId
 path True

string

The subscription identifier
api-version
 query True

string

The api version to use.

Request Body

Name Type Description
objectId

string

Gets or sets the object identifier of the admin.

Responses

Name Type Description
200 OK

Success
Other Status Codes

ErrorResponseModel

An error response received from the provider.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Accounts_AddRootCollectionAdmin

Sample request

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/addRootCollectionAdmin?api-version=2021-12-01

{
  "objectId": "7e8de0e7-2bfc-4e1f-9659-2a5785e4356f"
}

Sample response

Status code:
200 
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

Definitions

Name Description
CollectionAdminUpdate

Collection administrator update.
Error

Gets or sets the error.
ErrorModel

Default error model
ErrorResponseModel

Default error response model

CollectionAdminUpdate

Object

Collection administrator update.

Name Type Description
objectId

string

Gets or sets the object identifier of the admin.

Error

Object

Gets or sets the error.

Name Type Description
code

string

Gets or sets the code.
details

ErrorModel[]

Gets or sets the details.
message

string

Gets or sets the messages.
target

string

Gets or sets the target.

ErrorModel

Object

Default error model

Name Type Description
code

string

Gets or sets the code.
details

ErrorModel[]

Gets or sets the details.
message

string

Gets or sets the messages.
target

string

Gets or sets the target.

ErrorResponseModel

Object

Default error response model

Name Type Description
error

Error

Gets or sets the error.