library
turbot/okta
Get Involved
Version
Pipeline: Deactivate User
Deactivates a user. This operation can only be performed on users that do not have a DEPROVISIONED status.
Run the pipeline
To run this pipeline from your terminal:
flowpipe pipeline run okta.pipeline.deactivate_user \ --arg 'user_id=<string>' \ --arg 'send_email=<bool>'
Use this pipeline
To call this pipeline from your pipeline, use a step:
step "pipeline" "step_name" { pipeline = okta.pipeline.deactivate_user args = { user_id = <string> send_email = <bool> }}
Params
Name | Type | Required | Description | Default |
---|---|---|---|---|
cred | string | Yes | Name for credentials to use. If not provided, the default credentials will be used. | default |
user_id | string | Yes | The unique key for the user. | - |
send_email | bool | Yes | Send an email notifying the user that their account has been deactivated. | false |
Outputs
This pipeline has no outputs.