Skip to content

Latest commit

 

History

History
351 lines (251 loc) · 26.9 KB

README.md

File metadata and controls

351 lines (251 loc) · 26.9 KB
Raw

OrganizationMemberships

(organizationMemberships())

Overview

Available Operations

  • create - Create a new organization membership
  • list - Get a list of all members of an organization
  • update - Update an organization membership
  • delete - Remove a member from an organization
  • updateMetadata - Merge and update organization membership metadata
  • getAll - Get a list of all organization memberships within an instance.

create

Adds a user as a member to the given organization. Only users in the same instance as the organization can be added as members.

This organization will be the user's [active organization] (https://clerk.com/docs/organizations/overview#active-organization) the next time they create a session, presuming they don't explicitly set a different organization as active before then.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.CreateOrganizationMembershipRequestBody;
import com.clerk.backend_api.models.operations.CreateOrganizationMembershipResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
            .build();

        CreateOrganizationMembershipResponse res = sdk.organizationMemberships().create()
                .organizationId("<id>")
                .requestBody(CreateOrganizationMembershipRequestBody.builder()
                    .userId("<id>")
                    .role("<value>")
                    .build())
                .call();

        if (res.organizationMembership().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
organizationId String ✔️ The ID of the organization where the new membership will be created
requestBody CreateOrganizationMembershipRequestBody ✔️ N/A

Response

CreateOrganizationMembershipResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 400, 403, 404, 422 application/json
models/errors/SDKError 4XX, 5XX */*

list

Retrieves all user memberships for the given organization

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.ListOrganizationMembershipsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
            .build();

        ListOrganizationMembershipsResponse res = sdk.organizationMemberships().list()
                .organizationId("<id>")
                .limit(10L)
                .offset(0L)
                .orderBy("<value>")
                .call();

        if (res.organizationMemberships().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
organizationId String ✔️ The organization ID.
limit Optional<Long> ➖ Applies a limit to the number of results returned.
Can be used for paginating the results together with offset.
offset Optional<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.
orderBy Optional<String> ➖ Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username.
By prepending one of those values with + or -,
we can choose to sort in ascending (ASC) or descending (DESC) order."

Response

ListOrganizationMembershipsResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 401, 422 application/json
models/errors/SDKError 4XX, 5XX */*

update

Updates the properties of an existing organization membership

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.UpdateOrganizationMembershipRequestBody;
import com.clerk.backend_api.models.operations.UpdateOrganizationMembershipResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
            .build();

        UpdateOrganizationMembershipResponse res = sdk.organizationMemberships().update()
                .organizationId("<id>")
                .userId("<id>")
                .requestBody(UpdateOrganizationMembershipRequestBody.builder()
                    .role("<value>")
                    .build())
                .call();

        if (res.organizationMembership().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
organizationId String ✔️ The ID of the organization the membership belongs to
userId String ✔️ The ID of the user that this membership belongs to
requestBody UpdateOrganizationMembershipRequestBody ✔️ N/A

Response

UpdateOrganizationMembershipResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 400, 404, 422 application/json
models/errors/SDKError 4XX, 5XX */*

delete

Removes the given membership from the organization

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.DeleteOrganizationMembershipResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
            .build();

        DeleteOrganizationMembershipResponse res = sdk.organizationMemberships().delete()
                .organizationId("<id>")
                .userId("<id>")
                .call();

        if (res.organizationMembership().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
organizationId String ✔️ The ID of the organization the membership belongs to
userId String ✔️ The ID of the user that this membership belongs to

Response

DeleteOrganizationMembershipResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 400, 401, 404 application/json
models/errors/SDKError 4XX, 5XX */*

updateMetadata

Update an organization membership's metadata attributes by merging existing values with the provided parameters. Metadata values will be updated via a deep merge. Deep means that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to null.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.UpdateOrganizationMembershipMetadataRequestBody;
import com.clerk.backend_api.models.operations.UpdateOrganizationMembershipMetadataResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
            .build();

        UpdateOrganizationMembershipMetadataResponse res = sdk.organizationMemberships().updateMetadata()
                .organizationId("<id>")
                .userId("<id>")
                .requestBody(UpdateOrganizationMembershipMetadataRequestBody.builder()
                    .build())
                .call();

        if (res.organizationMembership().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
organizationId String ✔️ The ID of the organization the membership belongs to
userId String ✔️ The ID of the user that this membership belongs to
requestBody UpdateOrganizationMembershipMetadataRequestBody ✔️ N/A

Response

UpdateOrganizationMembershipMetadataResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 400, 404, 422 application/json
models/errors/SDKError 4XX, 5XX */*

getAll

Retrieves all organization user memberships for the given instance.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.InstanceGetOrganizationMembershipsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
            .build();

        InstanceGetOrganizationMembershipsResponse res = sdk.organizationMemberships().getAll()
                .limit(10L)
                .offset(0L)
                .orderBy("<value>")
                .call();

        if (res.organizationMemberships().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
limit Optional<Long> ➖ Applies a limit to the number of results returned.
Can be used for paginating the results together with offset.
offset Optional<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.
orderBy Optional<String> ➖ Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username.
By prepending one of those values with + or -,
we can choose to sort in ascending (ASC) or descending (DESC) order.

Response

InstanceGetOrganizationMembershipsResponse

Errors

Error Type Status Code Content Type
models/errors/ClerkErrors 400, 401, 422, 500 application/json
models/errors/SDKError 4XX, 5XX */*