Package com.onshape.api.requests

Class CompaniesAddUserRequest

java.lang.Object

com.onshape.api.requests.CompaniesAddUserRequest

public final class CompaniesAddUserRequest
extends Object

Request object for addUser API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompaniesAddUserRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CompaniesAddUserRequest.Builder	builder(Onshape onshape)
Boolean	getAdmin()	Get If the new user is an admin.
String	getCompanyId()	Get The company ID - should match the path.
String	getEmail()	Get The email.
Number[]	getGlobalPermissions()	Get List of global permissions for the new user.
Boolean	getGuest()	Get If the new user is a guest.
Boolean	getLight()	Get If the new user is a light user.
Boolean	getSendEmail()	Get If the new user should get an email.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getCompanyId

public final String getCompanyId()

Get The company ID - should match the path.

Returns:

The company ID - should match the path.

getEmail

public final String getEmail()

Get The email.

Returns:

The email.

getAdmin

public final Boolean getAdmin()

Get If the new user is an admin.

Returns:

If the new user is an admin.

getGuest

public final Boolean getGuest()

Get If the new user is a guest.

Returns:

If the new user is a guest.

getLight

public final Boolean getLight()

Get If the new user is a light user.

Returns:

If the new user is a light user.

getSendEmail

public final Boolean getSendEmail()

Get If the new user should get an email.

Returns:

If the new user should get an email.

getGlobalPermissions

public final Number[] getGlobalPermissions()

Get List of global permissions for the new user. OWNER=100, DELETE=90, RESHARE=80, WRITE=70, READ=60, LINK=50, COPY=30, EXPORT=20, COMMENT=10, ANONYMOUS_ACCESS=5.

Returns:

List of global permissions for the new user. OWNER=100, DELETE=90, RESHARE=80, WRITE=70, READ=60, LINK=50, COPY=30, EXPORT=20, COMMENT=10, ANONYMOUS_ACCESS=5.

toString

public String toString()

Overrides:

toString in class Object

builder

public static final CompaniesAddUserRequest.Builder builder(Onshape onshape)