Share via


Instances - Apply User

Force applies a user on a Dataverse environment. This API is deprecated.
For a list of region-specific service URLs, see Service URL

POST {ServiceUrl}/api/v1.2/Instances/{id}/Users/{userObjectId}/ApplyUser

URI Parameters

Name In Required Type Description
id
path True

string (uuid)

ID of the Dataverse environment to force apply the user.

userObjectId
path True

string (uuid)

UserObjectID of the user to force apply on the instance.

Responses

Name Type Description
202 Accepted

OperationStatus

The ApplyUser operation started.

Media Types: "application/json", "text/json"

400 Bad Request

OperationStatus

There was an issue either validating or starting the ApplyUser operation.

Media Types: "application/json", "text/json"

404 Not Found

NotFound

Media Types: "application/json", "text/json"

Definitions

Name Description
ItemDescription

Set of values to define an error or information item

OperationContext

The operation context object

OperationState

State of the operation

OperationStatus

Status of the operation

ItemDescription

Set of values to define an error or information item

Name Type Description
Code

string

Code of the item

Description

string

Description of the item

Subject

string

Subject of the item

OperationContext

The operation context object

Name Type Description
Items

object

The item object

OperationState

State of the operation

Value Description
Aborted
Aborting
Cancelled
Cancelling
Conflict
Deleted
Deleting
Failed
FailedToCreate
None
NotFound
NotStarted
Pending
Ready
Running
Succeeded
Tombstone

OperationStatus

Status of the operation

Name Type Description
Context

OperationContext

The operation context object

Errors

ItemDescription[]

Set of values to display errors during an operation

Information

ItemDescription[]

Set of values to display information during an operation

OperationId

string

ID of the operation

OperationLocation

string

Location of the operation

ResourceLocation

string

Location of the resource

Status

OperationState

State of the operation