Delete Access Profile(s)

POST 
/access-profiles/bulk-delete

This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use Get Task Status by ID, which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the inUse field of the response indicates the usages that must be removed first. If the request field bestEffortOnly is true, however, usages are reported in the inUse response field but all other indicated access profiles will be deleted. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this endpoint. In addition, a SOURCE_SUBADMIN can only use this endpoint to delete access profiles associated with sources they're able to administer.

Request

application/json

Body

required

accessProfileIds string[]

List of IDs of Access Profiles to be deleted.

bestEffortOnly boolean

If true, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If false, no deletions will be attempted if any of the Access Profiles are in use.

Responses

200

Returned only if bestEffortOnly is false, and one or more Access Profiles are in use.

application/json

Schema

Schema

taskId string

ID of the task which is executing the bulk deletion. This can be passed to the /task-status API to track status.

pending string[]

List of IDs of Access Profiles which are pending deletion.

inUse object[]
List of usages of Access Profiles targeted for deletion.
Array [
accessProfileId string
ID of the Access Profile that is in use
usedBy object[]
List of references to objects which are using the indicated Access Profile
Array [
type string
Possible values: [ROLE]
DTO type of role using the access profile.
id string
ID of role using the access profile.
name string
Display name of role using the access profile.
]
]

Example (from schema)

{
  "taskId": "2c9180867817ac4d017817c491119a20",
  "pending": [
    "2c91808876438bbb017668c21919ecca",
    "2c91808876438bb201766e129f151816"
  ],
  "inUse": [
    {
      "accessProfileId": "2c91808876438bbb017668c21919ecca",
      "usedBy": [
        {
          "type": "ROLE",
          "id": "2c8180857a9b3da0017aa03418480f9d",
          "name": "Manager Role"
        }
      ]
    }
  ]
}

Example

{
  "pending": [],
  "inUse": [
    {
      "accessProfileId": "2c91808876438ba801766e129f151816",
      "usages": [
        {
          "type": "Role",
          "id": "2c9180887643764201766e9f6e121518"
        }
      ]
    }
  ]
}

202

Returned if at least one deletion will be performed.

application/json

Schema

Schema

taskId string

ID of the task which is executing the bulk deletion. This can be passed to the /task-status API to track status.

pending string[]

List of IDs of Access Profiles which are pending deletion.

inUse object[]
List of usages of Access Profiles targeted for deletion.
Array [
accessProfileId string
ID of the Access Profile that is in use
usedBy object[]
List of references to objects which are using the indicated Access Profile
Array [
type string
Possible values: [ROLE]
DTO type of role using the access profile.
id string
ID of role using the access profile.
name string
Display name of role using the access profile.
]
]

Example (from schema)

{
  "taskId": "2c9180867817ac4d017817c491119a20",
  "pending": [
    "2c91808876438bbb017668c21919ecca",
    "2c91808876438bb201766e129f151816"
  ],
  "inUse": [
    {
      "accessProfileId": "2c91808876438bbb017668c21919ecca",
      "usedBy": [
        {
          "type": "ROLE",
          "id": "2c8180857a9b3da0017aa03418480f9d",
          "name": "Manager Role"
        }
      ]
    }
  ]
}

Example

{
  "taskId": "2c91808a7813090a01781412a1119a20",
  "pending": [
    "2c91808a7813090a017813fe1919ecca"
  ],
  "inUse": [
    {
      "accessProfileId": "2c91808876438ba801766e129f151816",
      "usages": [
        {
          "type": "Role",
          "id": "2c9180887643764201766e9f6e121518"
        }
      ]
    }
  ]
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...