Edit

Share via

Workspaces - Provision Identity

Service:
Core
API Version:
v1

Provision a workspace identity for a workspace.
This API supports long running operations (LRO).

Permissions

The caller must have an admin role in the workspace.

Required Delegated Scopes

Workspace.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/provisionIdentity

URI Parameters

Name In Required Type Description
workspaceId
 path True

string (uuid)

The ID of the workspace.

Responses

Name Type Description
200 OK

WorkspaceIdentity

Successfully provisioned
202 Accepted

Request accepted, identity provisioning in progress

Headers

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

Provision workspace identity example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff227/provisionIdentity

Sample response

Status code:
200 
{
  "applicationId": "00a4a8f9-78d3-41b3-b87a-6ae5271c8d0d",
  "servicePrincipalId": "5ba4ae58-d402-45c6-a848-0253e834fd78"
}
Status code:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 5

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
WorkspaceIdentity

A workspace identity object.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

WorkspaceIdentity

Object

A workspace identity object.

Name Type Description
applicationId

string

The application ID.
servicePrincipalId

string

The service principal ID.