Skip to content

README.md

Latest commit

 

History

History
119 lines (83 loc) · 6.73 KB

README.md

File metadata and controls

119 lines (83 loc) · 6.73 KB
Raw

Admin.Usage

Overview

Available Operations

getSettings

Retrieve workspace-wide policy from the same configuration used by Billing. Group resolution uses the configured policy and its backend defaults; business justification is currently optional. No per-user settings are read, and updated_at is omitted because no policy-update timestamp is available. Requires admin.usage.settings:read and permission to read workspace billing; a global administrator role is not required.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.errors.PlatformProblemDetailException;
import com.glean.api_client.glean_api_client.models.operations.PlatformAdminUsageSettingsGetResponse;
import java.lang.Exception;

public class Application {

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

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

        PlatformAdminUsageSettingsGetResponse res = sdk.admin().usage().getSettings()
                .call();

        if (res.platformUsageSettingsResponse().isPresent()) {
            System.out.println(res.platformUsageSettingsResponse().get());
        }
    }
}

Response

PlatformAdminUsageSettingsGetResponse

Errors

Error Type Status Code Content Type
models/errors/PlatformProblemDetailException 400, 401, 403, 404, 408, 429 application/problem+json
models/errors/PlatformProblemDetailException 500, 503 application/problem+json
models/errors/APIException 4XX, 5XX */*

updateSettings

Assign workspace-wide usage policy. Assignment is currently unavailable until a writer to authoritative Billing configuration is integrated. The backend config platform.usageSettingsWritesEnabled is disabled by default; enabling it alone does not implement assignment, and an authorized request still returns 503 without changing configuration or persisting a second copy of policy. Requires admin.usage.settings:write and permission to edit workspace billing; a global administrator role is not required.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.*;
import com.glean.api_client.glean_api_client.models.errors.PlatformProblemDetailException;
import com.glean.api_client.glean_api_client.models.operations.PlatformAdminUsageSettingsUpdateResponse;
import java.lang.Exception;

public class Application {

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

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

        PlatformUsageSettingsUpdateRequestUnion req = PlatformUsageSettingsUpdateRequestUnion.of(PlatformUsageSettingsUpdateRequest1.builder()
                .multipleMembershipResolution(PlatformMultipleMembershipResolutionSettings.builder()
                    .perMember(PlatformPerMemberSettings.builder()
                        .idpGroups(IdpGroups.HIGHEST)
                        .build())
                    .build())
                .limitIncreaseRequests(PlatformLimitIncreaseRequestSettings.builder()
                    .businessJustification(BusinessJustification.REQUIRED)
                    .build())
                .build());

        PlatformAdminUsageSettingsUpdateResponse res = sdk.admin().usage().updateSettings()
                .request(req)
                .call();

        if (res.platformUsageSettingsResponse().isPresent()) {
            System.out.println(res.platformUsageSettingsResponse().get());
        }
    }
}

Parameters

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

Response

PlatformAdminUsageSettingsUpdateResponse

Errors

Error Type Status Code Content Type
models/errors/PlatformProblemDetailException 400, 401, 403, 404, 408, 413, 429 application/problem+json
models/errors/PlatformProblemDetailException 500, 503 application/problem+json
models/errors/APIException 4XX, 5XX */*