Revoke - C1 documentation

Revoke

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/app-secrets-admin/revoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": {
    "appId": "<string>",
    "appResourceTypeId": "<string>",
    "id": "<string>"
  }
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/app-secrets-admin/revoke"

payload = { "ref": {
        "appId": "<string>",
        "appResourceTypeId": "<string>",
        "id": "<string>"
    } }
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({ref: {appId: '<string>', appResourceTypeId: '<string>', id: '<string>'}})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/app-secrets-admin/revoke', 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}.conductor.one/api/v1/app-secrets-admin/revoke",
  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([
    'ref' => [
        'appId' => '<string>',
        'appResourceTypeId' => '<string>',
        'id' => '<string>'
    ]
  ]),
  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}.conductor.one/api/v1/app-secrets-admin/revoke"

	payload := strings.NewReader("{\n  \"ref\": {\n    \"appId\": \"<string>\",\n    \"appResourceTypeId\": \"<string>\",\n    \"id\": \"<string>\"\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}.conductor.one/api/v1/app-secrets-admin/revoke")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ref\": {\n    \"appId\": \"<string>\",\n    \"appResourceTypeId\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/app-secrets-admin/revoke")

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  \"ref\": {\n    \"appId\": \"<string>\",\n    \"appResourceTypeId\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}"

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

{
  "credentialRevocation": {
    "state": "CREDENTIAL_REVOCATION_STATE_UNSPECIFIED"
  },
  "revoked": true
}

POST

/

api

/

v1

/

app-secrets-admin

/

revoke

Revoke

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/app-secrets-admin/revoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": {
    "appId": "<string>",
    "appResourceTypeId": "<string>",
    "id": "<string>"
  }
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/app-secrets-admin/revoke"

payload = { "ref": {
        "appId": "<string>",
        "appResourceTypeId": "<string>",
        "id": "<string>"
    } }
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({ref: {appId: '<string>', appResourceTypeId: '<string>', id: '<string>'}})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/app-secrets-admin/revoke', 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}.conductor.one/api/v1/app-secrets-admin/revoke",
  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([
    'ref' => [
        'appId' => '<string>',
        'appResourceTypeId' => '<string>',
        'id' => '<string>'
    ]
  ]),
  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}.conductor.one/api/v1/app-secrets-admin/revoke"

	payload := strings.NewReader("{\n  \"ref\": {\n    \"appId\": \"<string>\",\n    \"appResourceTypeId\": \"<string>\",\n    \"id\": \"<string>\"\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}.conductor.one/api/v1/app-secrets-admin/revoke")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ref\": {\n    \"appId\": \"<string>\",\n    \"appResourceTypeId\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/app-secrets-admin/revoke")

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  \"ref\": {\n    \"appId\": \"<string>\",\n    \"appResourceTypeId\": \"<string>\",\n    \"id\": \"<string>\"\n  }\n}"

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

{
  "credentialRevocation": {
    "state": "CREDENTIAL_REVOCATION_STATE_UNSPECIFIED"
  },
  "revoked": true
}

Authorizations

Authorization

string

header

required

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

Authorization

string

header

required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The AppSecretAdminServiceRevokeRequest message.

ref

App Secret Ref · object | null

The AppSecretRef message.

Show child attributes

Response

200 - application/json

Successful response

The AppSecretAdminServiceRevokeResponse message.

credentialRevocation

Credential Revocation · object | null

CredentialRevocation describes the current revoke eligibility of a credential C1 issued through credential vending.

Show child attributes

revoked

boolean

Successful calls queue a revoke and return true.