revokeOrganizationInvitationWithHttpInfo method

Future<Response> revokeOrganizationInvitationWithHttpInfo(
  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.

Note: This method returns the HTTP Response.

Parameters:

Implementation

Future<http.Response> revokeOrganizationInvitationWithHttpInfo(
  String organizationId,
  String invitationId, {
  RevokeOrganizationInvitationRequest? revokeOrganizationInvitationRequest,
}) async {
  // ignore: prefer_const_declarations
  final path =
      r'/organizations/{organization_id}/invitations/{invitation_id}/revoke'
          .replaceAll('{organization_id}', organizationId)
          .replaceAll('{invitation_id}', invitationId);

  // ignore: prefer_final_locals
  Object? postBody = revokeOrganizationInvitationRequest;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>['application/json'];

  return apiClient.invokeAPI(
    path,
    'POST',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}