delete-user¶

Description¶

Deletes a user. This includes deleting all associated access keys and unassigning all roles and resource roles assigned to the user. The user is also removed from all groups it belongs to. If the call succeeds the user will not be able to login interactively, or use any access keys to access the CDP control plane. This feature is under development and some resources may be left behind after a successful call. Note that user-sync is not triggered yet by this call and the caller must trigger that to ensure that the user loses access to all environments as soon as possible.

Synopsis¶

  delete-user
--user-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--user-id (string)

The ID or CRN of the user to delete.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

accessKeysDeleted -> (array)

The list of associated access key CRNs that were deleted.

item -> (string)

groupsModified -> (array)

The list of group CRNs from which the user has been removed.

item -> (string)

rolesUnassigned -> (array)

The list of role CRNs unassigned from the user.

item -> (string)

resourcesUnassigned -> (array)

The list of resource role assignments that have been unassigned from the user.

item -> (object)

Information about a resource assignment.

resourceCrn -> (string)

The assigned resource’s CRN.

resourceRoleCrn -> (string)

The assigned resource role CRN.

Form Factors¶

public, private