Package io.camunda.client.protocol.rest

Class AuthorizationRequest

java.lang.Object

io.camunda.client.protocol.rest.AuthorizationRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class AuthorizationRequest
extends Object

Defines an authorization request. Either an id-based or a property-based authorization can be provided.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_OWNER_ID
static final String	JSON_PROPERTY_OWNER_TYPE
static final String	JSON_PROPERTY_PERMISSION_TYPES
static final String	JSON_PROPERTY_RESOURCE_ID
static final String	JSON_PROPERTY_RESOURCE_PROPERTY_NAME
static final String	JSON_PROPERTY_RESOURCE_TYPE

Constructor Summary

Constructors

Constructor	Description
AuthorizationRequest()

Method Summary

Modifier and Type	Method	Description
AuthorizationRequest	addPermissionTypesItem(PermissionTypeEnum permissionTypesItem)
boolean	equals(Object o)
String	getOwnerId()	The ID of the owner of the permissions.
OwnerTypeEnum	getOwnerType()	Get ownerType
List<PermissionTypeEnum>	getPermissionTypes()	The permission types to add.
String	getResourceId()	The ID of the resource to add permissions to.
String	getResourcePropertyName()	The name of the resource property on which this authorization is based.
ResourceTypeEnum	getResourceType()	The type of resource to add permissions to.
int	hashCode()
AuthorizationRequest	ownerId(String ownerId)
AuthorizationRequest	ownerType(OwnerTypeEnum ownerType)
AuthorizationRequest	permissionTypes(List<PermissionTypeEnum> permissionTypes)
AuthorizationRequest	resourceId(String resourceId)
AuthorizationRequest	resourcePropertyName(String resourcePropertyName)
AuthorizationRequest	resourceType(ResourceTypeEnum resourceType)
void	setOwnerId(String ownerId)
void	setOwnerType(OwnerTypeEnum ownerType)
void	setPermissionTypes(List<PermissionTypeEnum> permissionTypes)
void	setResourceId(String resourceId)
void	setResourcePropertyName(String resourcePropertyName)
void	setResourceType(ResourceTypeEnum resourceType)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_OWNER_ID

public static final String JSON_PROPERTY_OWNER_ID

See Also:

• Constant Field Values

JSON_PROPERTY_OWNER_TYPE

public static final String JSON_PROPERTY_OWNER_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_RESOURCE_ID

public static final String JSON_PROPERTY_RESOURCE_ID

See Also:

• Constant Field Values

JSON_PROPERTY_RESOURCE_TYPE

public static final String JSON_PROPERTY_RESOURCE_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_PERMISSION_TYPES

public static final String JSON_PROPERTY_PERMISSION_TYPES

See Also:

• Constant Field Values

JSON_PROPERTY_RESOURCE_PROPERTY_NAME

public static final String JSON_PROPERTY_RESOURCE_PROPERTY_NAME

See Also:

• Constant Field Values

Constructor Details

AuthorizationRequest

public AuthorizationRequest()

Method Details

ownerId

public AuthorizationRequest ownerId(@Nonnull
 String ownerId)

getOwnerId

@Nonnull
public String getOwnerId()

The ID of the owner of the permissions.

Returns:

ownerId

setOwnerId

public void setOwnerId(@Nonnull
 String ownerId)

ownerType

public AuthorizationRequest ownerType(@Nonnull
 OwnerTypeEnum ownerType)

getOwnerType

@Nonnull
public OwnerTypeEnum getOwnerType()

Get ownerType

Returns:

ownerType

setOwnerType

public void setOwnerType(@Nonnull
 OwnerTypeEnum ownerType)

resourceId

public AuthorizationRequest resourceId(@Nonnull
 String resourceId)

getResourceId

@Nonnull
public String getResourceId()

The ID of the resource to add permissions to.

Returns:

resourceId

setResourceId

public void setResourceId(@Nonnull
 String resourceId)

resourceType

public AuthorizationRequest resourceType(@Nonnull
 ResourceTypeEnum resourceType)

getResourceType

@Nonnull
public ResourceTypeEnum getResourceType()

The type of resource to add permissions to.

Returns:

resourceType

setResourceType

public void setResourceType(@Nonnull
 ResourceTypeEnum resourceType)

permissionTypes

public AuthorizationRequest permissionTypes(@Nonnull
 List<PermissionTypeEnum> permissionTypes)

addPermissionTypesItem

public AuthorizationRequest addPermissionTypesItem(PermissionTypeEnum permissionTypesItem)

getPermissionTypes

@Nonnull
public List<PermissionTypeEnum> getPermissionTypes()

The permission types to add.

Returns:

permissionTypes

setPermissionTypes

public void setPermissionTypes(@Nonnull
 List<PermissionTypeEnum> permissionTypes)

resourcePropertyName

public AuthorizationRequest resourcePropertyName(@Nonnull
 String resourcePropertyName)

getResourcePropertyName

@Nonnull
public String getResourcePropertyName()

The name of the resource property on which this authorization is based.

Returns:

resourcePropertyName

setResourcePropertyName

public void setResourcePropertyName(@Nonnull
 String resourcePropertyName)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object