Users: deleteIdentities

Required scopes: user_write

Deletes user identities.

Request

HTTP request

DELETE /v2/organizations/{organizationId}/users/{userId}/identities

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

userIdstring

The user ID Guid

Request Body

requestModel

SDK Method

Users::deleteIdentities

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.UserIdentityResponse

Results of deleting a user identity.

idstring

The ID of the result.

provider_idstring

The ID of the identity provider.

user_idstring

The user ID.

immutable_idstring

A unique ID to identify the removed user.

error_detailsDocuSign.API.Organizations.Web.Models.RestApi.Common.ErrorDetails

Error results.

DocuSign.API.Organizations.Web.Models.RestApi.Common.ErrorDetails

Errors.

errorstring

Short description of the error.

error_descriptionstring

A longer description of the error.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.DeleteUserIdentityRequest

Request to delete a user's identities,

identities[DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UserIdentityRequest]

A list of identities.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Request.UserIdentityRequest

User identity,

idstring

The ID of the identity.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.DeleteResponse

Results of deleting identities.

successboolean

If true the request succeeded.

identities[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.UserIdentityResponse]

A list of identities to delete.

}} />