deleteOrganizationRole method

Future<DeletedObject?> deleteOrganizationRole(
  1. String organizationRoleId
)

Delete an organization role

Deletes the organization role. The role cannot be deleted if it is currently used as the default creator role, domain default role, assigned to any members, or exists in any invitations.

Parameters:

  • String organizationRoleId (required): The ID of the organization role to delete

Implementation

Future<DeletedObject?> deleteOrganizationRole(
  String organizationRoleId,
) async {
  final response = await deleteOrganizationRoleWithHttpInfo(
    organizationRoleId,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty &&
      response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'DeletedObject',
    ) as DeletedObject;
  }
  return null;
}