revokeOrganizationInvitation method

Future<OrganizationInvitation?> revokeOrganizationInvitation(
  1. String organizationId,
  2. String invitationId, {
  3. RevokeOrganizationInvitationRequest? revokeOrganizationInvitationRequest,
})

Revoke a pending organization invitation

Use this request to revoke a previously issued organization invitation. Revoking an organization invitation makes it invalid; the invited user will no longer be able to join the organization with the revoked invitation. Only organization invitations with "pending" status can be revoked. The request accepts the requesting_user_id parameter to specify the user which revokes the invitation. Only users with "admin" role can revoke invitations.

Parameters:

Implementation

Future<OrganizationInvitation?> revokeOrganizationInvitation(
  String organizationId,
  String invitationId, {
  RevokeOrganizationInvitationRequest? revokeOrganizationInvitationRequest,
}) async {
  final response = await revokeOrganizationInvitationWithHttpInfo(
    organizationId,
    invitationId,
    revokeOrganizationInvitationRequest: revokeOrganizationInvitationRequest,
  );
  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),
      'OrganizationInvitation',
    ) as OrganizationInvitation;
  }
  return null;
}