Delete memberships

Remove one member from this Organization. The underlying user account is not deleted.

POST /delete-memberships

Delete memberships

cURL

curl --request POST \
  --url https://{tenantDomain}/my-org/v1/delete-memberships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "members": [
    "auth0|1234567890"
  ]
}
'

import requests

url = "https://{tenantDomain}/my-org/v1/delete-memberships"

payload = { "members": ["auth0|1234567890"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({members: ['auth0|1234567890']})
};

fetch('https://{tenantDomain}/my-org/v1/delete-memberships', 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://{tenantDomain}/my-org/v1/delete-memberships",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'members' => [
        'auth0|1234567890'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{tenantDomain}/my-org/v1/delete-memberships"

	payload := strings.NewReader("{\n  \"members\": [\n    \"auth0|1234567890\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/my-org/v1/delete-memberships")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"members\": [\n    \"auth0|1234567890\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/delete-memberships")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"members\": [\n    \"auth0|1234567890\"\n  ]\n}"

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

400

{
  "type": "https://auth0.com/api-errors#A0E-400-0003",
  "status": 400,
  "title": "Validation Error",
  "validation_errors": [
    {
      "detail": "is required",
      "field": "data/property_name",
      "pointer": "/property_name",
      "source": "params"
    }
  ]
}

{
  "type": "https://auth0.com/api-errors#A0E-401-0002",
  "status": 401,
  "title": "Missing Token",
  "detail": "No auth token provided."
}

{
  "type": "https://auth0.com/api-errors#A0E-403-0002",
  "status": 403,
  "title": "Insufficient Scope",
  "detail": "The auth token lacks the required scope: Check the API documentation for the required scopes for this endpoint."
}

{
  "type": "https://auth0.com/api-errors#A0E-404-0002",
  "status": 404,
  "title": "Resource Not Found",
  "detail": "The organization does not exist."
}

{
  "type": "https://auth0.com/api-errors#A0E-429-0003",
  "status": 429,
  "title": "Endpoint Rate Limit Exceeded",
  "detail": "The endpoint request limit has been exceeded."
}

Autorisations

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · requis

The access token received from the authorization server in the OAuth 2.0 flow.

Corps

application/json

members · string[] · requis

Required array length: 1 element

The user ID.

Pattern: ^(?=.{1,1024}$).+\|.+$

Réponse

204

The Organization memberships were removed successfully.