(invitations())
Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error.
package hello.world;
import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;
public class Application {
public static void main(String[] args) throws Exception {
try {
Clerk sdk = Clerk.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
CreateInvitationRequestBody req = CreateInvitationRequestBody.builder()
.emailAddress("<value>")
.build();
CreateInvitationResponse res = sdk.invitations().create()
.request(req)
.call();
if (res.invitation().isPresent()) {
// handle response
}
} catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
// handle exception
throw e;
} catch (com.clerk.backend_api.models.errors.SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
request |
com.clerk.backend_api.models.operations.CreateInvitationRequestBody | ✔️ | The request object to use for the request. |
Optional<? extends com.clerk.backend_api.models.operations.CreateInvitationResponse>
| Error Object | Status Code | Content Type |
|---|---|---|
| models/errors/ClerkErrors | 400,422 | application/json |
| models/errors/SDKError | 4xx-5xx | / |
Returns all non-revoked invitations for your application, sorted by creation date
package hello.world;
import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;
public class Application {
public static void main(String[] args) throws Exception {
try {
Clerk sdk = Clerk.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
ListInvitationsResponse res = sdk.invitations().list()
.limit(10L)
.offset(0L)
.status(QueryParamStatus.REVOKED)
.call();
while (true) {
if (res.invitationList().isPresent()) {
// handle response
Optional<ListInvitationsResponse> nextRes = res.next();
if (nextRes.isPresent()) {
res = nextRes.get();
} else {
break;
}
}
}
} catch (com.clerk.backend_api.models.errors.SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
limit |
Optional<? extends Long> | ➖ | Applies a limit to the number of results returned. Can be used for paginating the results together with offset. |
offset |
Optional<? extends Long> | ➖ | Skip the first offset results when paginating.Needs to be an integer greater or equal to zero. To be used in conjunction with limit. |
status |
Optional<? extends com.clerk.backend_api.models.operations.QueryParamStatus> | ➖ | Filter invitations based on their status |
Optional<? extends com.clerk.backend_api.models.operations.ListInvitationsResponse>
| Error Object | Status Code | Content Type |
|---|---|---|
| models/errors/SDKError | 4xx-5xx | / |
Revokes the given invitation. Revoking an invitation will prevent the user from using the invitation link that was sent to them. However, it doesn't prevent the user from signing up if they follow the sign up flow. Only active (i.e. non-revoked) invitations can be revoked.
package hello.world;
import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;
public class Application {
public static void main(String[] args) throws Exception {
try {
Clerk sdk = Clerk.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
RevokeInvitationResponse res = sdk.invitations().revoke()
.invitationId("<value>")
.call();
if (res.invitationRevoked().isPresent()) {
// handle response
}
} catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
// handle exception
throw e;
} catch (com.clerk.backend_api.models.errors.SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
invitationId |
String | ✔️ | The ID of the invitation to be revoked |
Optional<? extends com.clerk.backend_api.models.operations.RevokeInvitationResponse>
| Error Object | Status Code | Content Type |
|---|---|---|
| models/errors/ClerkErrors | 400,404 | application/json |
| models/errors/SDKError | 4xx-5xx | / |