Package com.flagright.api.resources.businessusers

Class BusinessUsersClient

java.lang.Object

com.flagright.api.resources.businessusers.BusinessUsersClient

public class BusinessUsersClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
BusinessUsersClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
BusinessUsersCreateResponse	create(BusinessUsersCreateRequest request)	POST Business User
BusinessUsersCreateResponse	create(BusinessUsersCreateRequest request, RequestOptions requestOptions)	POST Business User
BusinessWithRulesResult	get(java.lang.String userId)	GET Business User
BusinessWithRulesResult	get(java.lang.String userId, RequestOptions requestOptions)	GET Business User
RawBusinessUsersClient	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

BusinessUsersClient

public BusinessUsersClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawBusinessUsersClient withRawResponse()

Get responses with HTTP metadata like headers

create

public BusinessUsersCreateResponse create(BusinessUsersCreateRequest request)

POST Business User

/business/user endpoint allows you to operate on the Business 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 business user needs three mandatory fields:

• userId - Unique identifier for the user
• legalEntity - Details of the business legal entity (CompanyGeneralDetails, FinancialDetails etc) - only legalNamein CompanyGeneralDetails is mandatory
• createdTimestamp - UNIX timestamp in milliseconds for when the User is created in your system

create

public BusinessUsersCreateResponse create(BusinessUsersCreateRequest request,
                                          RequestOptions requestOptions)

POST Business User

/business/user endpoint allows you to operate on the Business 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 business user needs three mandatory fields:

• userId - Unique identifier for the user
• legalEntity - Details of the business legal entity (CompanyGeneralDetails, FinancialDetails etc) - only legalNamein CompanyGeneralDetails is mandatory
• createdTimestamp - UNIX timestamp in milliseconds for when the User is created in your system

get

public BusinessWithRulesResult get(java.lang.String userId)

GET Business User

/business/user endpoint allows you to operate on the Business User entity.

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

get

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

GET Business User

/business/user endpoint allows you to operate on the Business User entity.

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