Delete a role

DELETE

/v1/iam/roles/{id}

const url = 'http://localhost:8080/v1/iam/roles/example';
const options = {method: 'DELETE'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url http://localhost:8080/v1/iam/roles/example

Refusé si isSystem=true. Refusé si le rôle est encore utilisé par un IdentityAccess, ApiKey, ou User.defaultRole (409 role_in_use).

Parameters

Path Parameters

required

string

Responses

200

Role deleted.

application/json

object

status

required

string

Allowed value: success

code

required

string

data

required

object

deleted

required

boolean

deletedAt

required

string format: date-time

required

string

cache

object

hit

required

boolean

key

string

ageSeconds

integer

expiresAt

string format: date-time

timing

object

totalMs

required

integer

dbMs

integer

externalMs

integer

deprecation

object

sunset

required

string format: date-time

successor

string

note

string

Example

{
  "status": "success",
  "data": {
    "deleted": true
  }
}

401

Authentification manquante ou invalide.

application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

403

Scope insuffisant (forbidden, no_active_plan, service_disabled_on_plan).

application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

404

Ressource introuvable (ou hors-tenant).

application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

409

Conflit d’état (cannot_replay_<status>, idempotency_mismatch).

application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}