README.md

Indexing.Permissions

Overview

Available Operations

• updatePermissions - Update document permissions
• indexUser - Index user
• bulkIndexUsers - Bulk index users
• indexGroup - Index group
• bulkIndexGroups - Bulk index groups
• indexMembership - Index membership
• bulkIndexMemberships - Bulk index memberships for a group
• processMemberships - Schedules the processing of group memberships
• deleteUser - Delete user
• deleteGroup - Delete group
• deleteMembership - Delete membership
• authorizeBetaUsers - Beta users

updatePermissions

Updates the permissions for a given document without modifying document content.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.DocumentPermissionsDefinition;
import com.glean.api_client.glean_api_client.models.components.UpdatePermissionsRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1UpdatepermissionsResponse;
import java.lang.Exception;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        UpdatePermissionsRequest req = UpdatePermissionsRequest.builder()
                .datasource("<value>")
                .permissions(DocumentPermissionsDefinition.builder()
                    .build())
                .build();

        PostApiIndexV1UpdatepermissionsResponse res = sdk.indexing().permissions().updatePermissions()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	UpdatePermissionsRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1UpdatepermissionsResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

indexUser

Adds a datasource user or updates an existing user.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.DatasourceUserDefinition;
import com.glean.api_client.glean_api_client.models.components.IndexUserRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1IndexuserResponse;
import java.lang.Exception;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        IndexUserRequest req = IndexUserRequest.builder()
                .datasource("<value>")
                .user(DatasourceUserDefinition.builder()
                    .email("Art.Schaden@hotmail.com")
                    .name("<value>")
                    .build())
                .build();

        PostApiIndexV1IndexuserResponse res = sdk.indexing().permissions().indexUser()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	IndexUserRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1IndexuserResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

bulkIndexUsers

Replaces the users in a datasource using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints. Note: Any users deleted from the existing set will have their associated memberships deleted as well.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.BulkIndexUsersRequest;
import com.glean.api_client.glean_api_client.models.components.DatasourceUserDefinition;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1BulkindexusersResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        BulkIndexUsersRequest req = BulkIndexUsersRequest.builder()
                .uploadId("<id>")
                .datasource("<value>")
                .users(List.of(
                    DatasourceUserDefinition.builder()
                        .email("Ivory_Cummerata@hotmail.com")
                        .name("<value>")
                        .build(),
                    DatasourceUserDefinition.builder()
                        .email("Ivory_Cummerata@hotmail.com")
                        .name("<value>")
                        .build(),
                    DatasourceUserDefinition.builder()
                        .email("Ivory_Cummerata@hotmail.com")
                        .name("<value>")
                        .build()))
                .build();

        PostApiIndexV1BulkindexusersResponse res = sdk.indexing().permissions().bulkIndexUsers()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	BulkIndexUsersRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1BulkindexusersResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

indexGroup

Add or update a group in the datasource.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.DatasourceGroupDefinition;
import com.glean.api_client.glean_api_client.models.components.IndexGroupRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1IndexgroupResponse;
import java.lang.Exception;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        IndexGroupRequest req = IndexGroupRequest.builder()
                .datasource("<value>")
                .group(DatasourceGroupDefinition.builder()
                    .name("<value>")
                    .build())
                .build();

        PostApiIndexV1IndexgroupResponse res = sdk.indexing().permissions().indexGroup()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	IndexGroupRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1IndexgroupResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

bulkIndexGroups

Replaces the groups in a datasource using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints. Note: Any groups deleted from the existing set will have their associated memberships deleted as well.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.BulkIndexGroupsRequest;
import com.glean.api_client.glean_api_client.models.components.DatasourceGroupDefinition;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1BulkindexgroupsResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        BulkIndexGroupsRequest req = BulkIndexGroupsRequest.builder()
                .uploadId("<id>")
                .datasource("<value>")
                .groups(List.of(
                    DatasourceGroupDefinition.builder()
                        .name("<value>")
                        .build(),
                    DatasourceGroupDefinition.builder()
                        .name("<value>")
                        .build()))
                .build();

        PostApiIndexV1BulkindexgroupsResponse res = sdk.indexing().permissions().bulkIndexGroups()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	BulkIndexGroupsRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1BulkindexgroupsResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

indexMembership

Add the memberships of a group in the datasource.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.DatasourceMembershipDefinition;
import com.glean.api_client.glean_api_client.models.components.IndexMembershipRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1IndexmembershipResponse;
import java.lang.Exception;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        IndexMembershipRequest req = IndexMembershipRequest.builder()
                .datasource("<value>")
                .membership(DatasourceMembershipDefinition.builder()
                    .groupName("<value>")
                    .build())
                .build();

        PostApiIndexV1IndexmembershipResponse res = sdk.indexing().permissions().indexMembership()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	IndexMembershipRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1IndexmembershipResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

bulkIndexMemberships

Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.BulkIndexMembershipsRequest;
import com.glean.api_client.glean_api_client.models.components.DatasourceBulkMembershipDefinition;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1BulkindexmembershipsResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        BulkIndexMembershipsRequest req = BulkIndexMembershipsRequest.builder()
                .uploadId("<id>")
                .datasource("<value>")
                .memberships(List.of(
                    DatasourceBulkMembershipDefinition.builder()
                        .build(),
                    DatasourceBulkMembershipDefinition.builder()
                        .build(),
                    DatasourceBulkMembershipDefinition.builder()
                        .build()))
                .build();

        PostApiIndexV1BulkindexmembershipsResponse res = sdk.indexing().permissions().bulkIndexMemberships()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	BulkIndexMembershipsRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1BulkindexmembershipsResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

processMemberships

Schedules the immediate processing of all group memberships uploaded through the indexing API. By default the uploaded group memberships will be processed asynchronously but this API can be used to schedule processing of all memberships on demand.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1ProcessallmembershipsResponse;
import java.lang.Exception;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        PostApiIndexV1ProcessallmembershipsResponse res = sdk.indexing().permissions().processMemberships()
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	ProcessAllMembershipsRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1ProcessallmembershipsResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

deleteUser

Delete the user from the datasource. Silently succeeds if user is not present. Note: All memberships associated with the deleted user will also be deleted.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.DeleteUserRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1DeleteuserResponse;
import java.lang.Exception;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        DeleteUserRequest req = DeleteUserRequest.builder()
                .datasource("<value>")
                .email("Ed.Johnston@gmail.com")
                .build();

        PostApiIndexV1DeleteuserResponse res = sdk.indexing().permissions().deleteUser()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	DeleteUserRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1DeleteuserResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

deleteGroup

Delete group from the datasource. Silently succeeds if group is not present. Note: All memberships associated with the deleted group will also be deleted.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.DeleteGroupRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1DeletegroupResponse;
import java.lang.Exception;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        DeleteGroupRequest req = DeleteGroupRequest.builder()
                .datasource("<value>")
                .groupName("<value>")
                .build();

        PostApiIndexV1DeletegroupResponse res = sdk.indexing().permissions().deleteGroup()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	DeleteGroupRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1DeletegroupResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

deleteMembership

Delete membership to a group in the specified datasource. Silently succeeds if membership is not present.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.DatasourceMembershipDefinition;
import com.glean.api_client.glean_api_client.models.components.DeleteMembershipRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1DeletemembershipResponse;
import java.lang.Exception;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        DeleteMembershipRequest req = DeleteMembershipRequest.builder()
                .datasource("<value>")
                .membership(DatasourceMembershipDefinition.builder()
                    .groupName("<value>")
                    .build())
                .build();

        PostApiIndexV1DeletemembershipResponse res = sdk.indexing().permissions().deleteMembership()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	DeleteMembershipRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1DeletemembershipResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

authorizeBetaUsers

Allow the datasource be visible to the specified beta users. The default behaviour is datasource being visible to all users if it is enabled and not visible to any user if it is not enabled.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.GreenlistUsersRequest;
import com.glean.api_client.glean_api_client.models.operations.PostApiIndexV1BetausersResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

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

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        GreenlistUsersRequest req = GreenlistUsersRequest.builder()
                .datasource("<value>")
                .emails(List.of(
                    "Neil92@gmail.com",
                    "Alejandrin_Boyer4@hotmail.com",
                    "Shyanne_McLaughlin95@hotmail.com"))
                .build();

        PostApiIndexV1BetausersResponse res = sdk.indexing().permissions().authorizeBetaUsers()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	GreenlistUsersRequest	✔️	The request object to use for the request.

Response

PostApiIndexV1BetausersResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*