Package com.flagright.api.resources.consumerusers

Class ConsumerUsersClient

java.lang.Object

com.flagright.api.resources.consumerusers.ConsumerUsersClient

public class ConsumerUsersClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ConsumerUsersClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ConsumerUsersCreateResponse	create(ConsumerUsersCreateRequest request)	POST Consumer User
ConsumerUsersCreateResponse	create(ConsumerUsersCreateRequest request, RequestOptions requestOptions)	POST Consumer User
UserWithRulesResult	get(java.lang.String userId)	GET Consumer User
UserWithRulesResult	get(java.lang.String userId, RequestOptions requestOptions)	GET Consumer User
RawConsumerUsersClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

ConsumerUsersClient

public ConsumerUsersClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawConsumerUsersClient withRawResponse()

Get responses with HTTP metadata like headers

create

public ConsumerUsersCreateResponse create(ConsumerUsersCreateRequest request)

POST Consumer User

/consumer/user endpoint allows you to operate on the Consumer user entity.

In order to pass the payload of a User to Flagright and verify the User, you will need to call this endpoint with the User payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.

Payload

Each consumer user needs two mandatory fields:

• userId - Unique identifier for the user
• createdTimestamp - UNIX timestamp in milliseconds for when the User is created in your system

create

public ConsumerUsersCreateResponse create(ConsumerUsersCreateRequest request,
                                          RequestOptions requestOptions)

POST Consumer User

/consumer/user endpoint allows you to operate on the Consumer user entity.

In order to pass the payload of a User to Flagright and verify the User, you will need to call this endpoint with the User payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.

Payload

Each consumer user needs two mandatory fields:

• userId - Unique identifier for the user
• createdTimestamp - UNIX timestamp in milliseconds for when the User is created in your system

get

public UserWithRulesResult get(java.lang.String userId)

GET Consumer User

/consumer/user endpoint allows you to operate on the Consumer User entity.

Calling GET /consumer/user/{userId} will return the entire user payload and rule execution results for the user with the corresponding userId

get

public UserWithRulesResult get(java.lang.String userId,
                               RequestOptions requestOptions)

GET Consumer User

/consumer/user endpoint allows you to operate on the Consumer User entity.

Calling GET /consumer/user/{userId} will return the entire user payload and rule execution results for the user with the corresponding userId