Iam

Overview

Available Operations

listUsers - List Users
getUser - Get User
updateUser - Update User
deleteUser - Delete User
listRoles - List Roles
getRole - Get Role
listGroups - List Groups
getGroup - Get Group
listPolicies - List Policies
getPolicy - Get Policy

listUsers

List Users

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamListUsersRequest req = IamListUsersRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled,unified_custom_fields")
                .filter(IamListUsersQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .expand("roles,groups")
                .prefer("heartbeat")
                .build();


        sdk.iam().listUsers()
                .callAsStream()
                .forEach((IamListUsersResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

IamListUsersResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getUser

Get User

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.IamGetUserRequest;
import com.stackone.stackone_client_java.models.operations.IamGetUserResponse;
import java.lang.Exception;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamGetUserRequest req = IamGetUserRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled,unified_custom_fields")
                .expand("roles,groups")
                .prefer("heartbeat")
                .build();

        IamGetUserResponse res = sdk.iam().getUser()
                .request(req)
                .call();

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

Parameters

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

Response

IamGetUserResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

updateUser

Update User

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.IamUpdateUserResponse;
import java.lang.Exception;
import java.util.Map;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamUpdateUserResponse res = sdk.iam().updateUser()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .iamUpdateUserRequestDto(IamUpdateUserRequestDto.builder()
                    .primaryEmailAddress("han@stackone.com")
                    .firstName("Han")
                    .lastName("Solo")
                    .name("Han Solo")
                    .username("hansolo1977")
                    .isBotUser(IamUpdateUserRequestDtoIsBotUser.of(true))
                    .status(IamUpdateUserRequestDtoStatus.builder()
                        .value(IamUpdateUserRequestDtoValue.ENABLED)
                        .build())
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`id`	String	✔️	N/A
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`iamUpdateUserRequestDto`	IamUpdateUserRequestDto	✔️	N/A

Response

IamUpdateUserResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

deleteUser

Delete User

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.IamDeleteUserResponse;
import java.lang.Exception;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamDeleteUserResponse res = sdk.iam().deleteUser()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`id`	String	✔️	N/A
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat

Response

IamDeleteUserResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

listRoles

List Roles

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamListRolesRequest req = IamListRolesRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,type,policies,description,created_at,updated_at,unified_custom_fields")
                .filter(IamListRolesQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .expand("policies")
                .prefer("heartbeat")
                .build();


        sdk.iam().listRoles()
                .callAsStream()
                .forEach((IamListRolesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

IamListRolesResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getRole

Get Role

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.IamGetRoleRequest;
import com.stackone.stackone_client_java.models.operations.IamGetRoleResponse;
import java.lang.Exception;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamGetRoleRequest req = IamGetRoleRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,type,policies,description,created_at,updated_at,unified_custom_fields")
                .expand("policies")
                .prefer("heartbeat")
                .build();

        IamGetRoleResponse res = sdk.iam().getRole()
                .request(req)
                .call();

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

Parameters

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

Response

IamGetRoleResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

listGroups

List Groups

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.IamListGroupsRequest;
import com.stackone.stackone_client_java.models.operations.IamListGroupsResponse;
import java.lang.Exception;
import org.openapitools.jackson.nullable.JsonNullable;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamListGroupsRequest req = IamListGroupsRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at,unified_custom_fields")
                .filter(JsonNullable.of(null))
                .expand("roles")
                .prefer("heartbeat")
                .build();


        sdk.iam().listGroups()
                .callAsStream()
                .forEach((IamListGroupsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

IamListGroupsResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getGroup

Get Group

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.IamGetGroupRequest;
import com.stackone.stackone_client_java.models.operations.IamGetGroupResponse;
import java.lang.Exception;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamGetGroupRequest req = IamGetGroupRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at,unified_custom_fields")
                .expand("roles")
                .prefer("heartbeat")
                .build();

        IamGetGroupResponse res = sdk.iam().getGroup()
                .request(req)
                .call();

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

Parameters

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

Response

IamGetGroupResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

listPolicies

List Policies

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.IamListPoliciesRequest;
import com.stackone.stackone_client_java.models.operations.IamListPoliciesResponse;
import java.lang.Exception;
import org.openapitools.jackson.nullable.JsonNullable;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamListPoliciesRequest req = IamListPoliciesRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,permissions,description,created_at,updated_at,unified_custom_fields")
                .filter(JsonNullable.of(null))
                .expand("permissions")
                .prefer("heartbeat")
                .build();


        sdk.iam().listPolicies()
                .callAsStream()
                .forEach((IamListPoliciesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

IamListPoliciesResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getPolicy

Get Policy

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.IamGetPolicyRequest;
import com.stackone.stackone_client_java.models.operations.IamGetPolicyResponse;
import java.lang.Exception;

public class Application {

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

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        IamGetPolicyRequest req = IamGetPolicyRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,permissions,description,created_at,updated_at,unified_custom_fields")
                .expand("permissions")
                .prefer("heartbeat")
                .build();

        IamGetPolicyResponse res = sdk.iam().getPolicy()
                .request(req)
                .call();

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

Parameters

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

Response

IamGetPolicyResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Iam

Overview

Available Operations

listUsers

Example Usage

Parameters

Response

Errors

getUser

Example Usage

Parameters

Response

Errors

updateUser

Example Usage

Parameters

Response

Errors

deleteUser

Example Usage

Parameters

Response

Errors

listRoles

Example Usage

Parameters

Response

Errors

getRole

Example Usage

Parameters

Response

Errors

listGroups

Example Usage

Parameters

Response

Errors

getGroup

Example Usage

Parameters

Response

Errors

listPolicies

Example Usage

Parameters

Response

Errors

getPolicy

Example Usage

Parameters

Response

Errors