Delete user

DELETE 
/nevisidm/api/scim/v1/:clientExtId/Users/:id

Deletes a user and all related resources (credentials, profiles, authorizations). The user must belong to the client specified by clientExtId in the URL path.

Request

Path Parameters

clientExtId stringrequired
Client's external identifier.
Example: 100
id stringrequired
User's internal identifier.
Example: 100

Responses

204

User deleted successfully

application/json

Schema

Schema

schemas string[]required

An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ]
}

400

Invalid SCIM request

application/json

Schema

Schema

schemas string[]required

An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

status HttpStatusCoderequired
The HTTP status code.
error boolean
is1xxInformational boolean
is2xxSuccessful boolean
is3xxRedirection boolean
is4xxClientError boolean
is5xxServerError boolean
scimType string

Possible values: [invalidFilter, tooMany, uniqueness, mutability, invalidSyntax, invalidPath, noTarget, invalidValue, invalidVers, sensitive]

A SCIM detail error keyword.

detail string

A detailed human-readable message.

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "status": 400,
  "scimType": "invalidValue",
  "detail": "The requested user '999' does not exist in IDM database."
}

User ID not parseable

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "status": "BAD_REQUEST",
  "scimType": "invalidValue",
  "detail": "The requested user 'abc' cannot be parsed as number."
}

User does not belong to client

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "status": "BAD_REQUEST",
  "scimType": "invalidValue",
  "detail": "The requested user does not belong to the actual client."
}

404

SCIM user not found

application/json

Schema

Schema

schemas string[]required

An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

status HttpStatusCoderequired
The HTTP status code.
error boolean
is1xxInformational boolean
is2xxSuccessful boolean
is3xxRedirection boolean
is4xxClientError boolean
is5xxServerError boolean
scimType string

Possible values: [invalidFilter, tooMany, uniqueness, mutability, invalidSyntax, invalidPath, noTarget, invalidValue, invalidVers, sensitive]

A SCIM detail error keyword.

detail string

A detailed human-readable message.

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "status": 400,
  "scimType": "invalidValue",
  "detail": "The requested user '999' does not exist in IDM database."
}

User not found

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "status": "NOT_FOUND",
  "scimType": "invalidValue",
  "detail": "The requested user '999' does not exist in IDM database."
}

Loading...