Disable User

PUT

organizations

{organization_id}

users

{user_id}

disable

Disable User

curl --request PUT \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable \
  --header 'Authorization: Bearer <token>' \
  --header 'x-organization-secret: <x-organization-secret>'

import requests

url = "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable"

headers = {
    "x-organization-secret": "<x-organization-secret>",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-organization-secret': '<x-organization-secret>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-organization-secret: <x-organization-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("x-organization-secret", "<x-organization-secret>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable")
  .header("x-organization-secret", "<x-organization-secret>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-organization-secret"] = '<x-organization-secret>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "statusCode": 200,
  "message": "User disabled successfully",
  "code": "SUCCESS",
  "data": {
    "user_id": "a7748dfd-ceb2-4b17-8380-425c304f5ae7"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

Overview

Disables the user: marks them disabled, downgrades their roles to member and blocks sign-in. No request body. Idempotent: a user who is already disabled returns 200 with "User is already disabled". Requires the update:user scope.

Response Examples

Disabled (200)

{
  "success": true,
  "statusCode": 200,
  "message": "User disabled successfully",
  "code": "SUCCESS",
  "data": {
    "user_id": "a7748dfd-ceb2-4b17-8380-425c304f5ae7"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

Already Disabled (200)

{
  "success": true,
  "statusCode": 200,
  "message": "User is already disabled",
  "code": "SUCCESS",
  "data": {
    "user_id": "a7748dfd-ceb2-4b17-8380-425c304f5ae7"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

Response Fields

Field	Type	Description
`user_id`	string	Parchment’s user ID

Status Codes

Code	Status	Description
`200`	OK	User disabled, or already disabled
`400`	Bad Request	Target user has no email address
`401`	Unauthorized	Token invalid, or missing `update:user` scope
`404`	Not Found	User not found
`500`	Internal Server Error	Unexpected server error

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-organization-secret

string

required

Organization secret for authentication - provided by Parchment

Path Parameters

organization_id

string<uuid>

required

Organization ID

user_id

string<uuid>

required

User ID

Response

User disabled, or already disabled.

success

boolean

required

Always true

Example:

true

statusCode

integer

required

HTTP status code

Example:

200

message

string

required

Outcome summary.

Example:

"User disabled successfully"

code

enum<string>

required

Always SUCCESS.

Available options:

SUCCESS

Example:

"SUCCESS"

data

object

required

Show child attributes

timestamp

string<date-time>

required

ISO 8601 timestamp of the response

Example:

"2024-01-15T10:30:00.000Z"

requestId

string

required

Unique identifier for request tracing

Example:

"req_1705312200000_abc123"

Disable User

curl --request PUT \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable \
  --header 'Authorization: Bearer <token>' \
  --header 'x-organization-secret: <x-organization-secret>'

import requests

url = "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable"

headers = {
    "x-organization-secret": "<x-organization-secret>",
    "Authorization": "Bearer <token>"
}

response = requests.put(url, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-organization-secret': '<x-organization-secret>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-organization-secret: <x-organization-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("x-organization-secret", "<x-organization-secret>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable")
  .header("x-organization-secret", "<x-organization-secret>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/disable")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-organization-secret"] = '<x-organization-secret>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "statusCode": 200,
  "message": "User disabled successfully",
  "code": "SUCCESS",
  "data": {
    "user_id": "a7748dfd-ceb2-4b17-8380-425c304f5ae7"
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_abc123"
}

API Documentation

Authentication

Authentication Endpoints

Patient Management Endpoints

User Management Endpoints

Custom Drug Endpoints

Overview

Response Examples

Disabled (200)

Already Disabled (200)

Response Fields

Status Codes

Authorizations

Headers

Path Parameters

Response

​Overview

​Response Examples

​Disabled (200)

​Already Disabled (200)

​Response Fields

​Status Codes

Authorizations

Headers

Path Parameters

Response

Overview

Response Examples

Disabled (200)

Already Disabled (200)

Response Fields

Status Codes