Richemont.Booster2.PublicApi

<back to all web services

CreateUserAuth

Requires Authentication
The following routes are available for this service:
POST/user/{brand}/{userId}/authorizeCreate the authorization for the given external user and for the given POS CodesThe 'CreateUserAuth' API is not implemented for internal users

export class CreateUserAuthResponse
{

    public constructor(init?: Partial<CreateUserAuthResponse>) { (Object as any).assign(this, init); }
}

export class AuthRequest
{
    /** @description POS Code (only for external users) */
    // @ApiMember(Description="POS Code (only for external users)", IsRequired=true)
    public posCode: string;

    /** @description Roles for users (GUIDs). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2' */
    // @ApiMember(Description="Roles for users (GUIDs). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2'", IsRequired=true)
    public roles: string[];

    public constructor(init?: Partial<AuthRequest>) { (Object as any).assign(this, init); }
}

export class CreateUserAuth
{
    /** @description User's UserID (GUID). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2' */
    // @ApiMember(Description="User's UserID (GUID). E.g. '731cd7f3-a781-48bf-b43d-310273895ce2'", IsRequired=true)
    public userId: string;

    /** @description Brand Trigram, e.g. CAR, IWC, VAC */
    // @ApiMember(Description="Brand Trigram, e.g. CAR, IWC, VAC", IsRequired=true)
    public brand: string;

    /** @description Authorization requests for the provided user */
    // @ApiMember(Description="Authorization requests for the provided user", IsRequired=true)
    public authRequests: AuthRequest[];

    public constructor(init?: Partial<CreateUserAuth>) { (Object as any).assign(this, init); }
}

TypeScript CreateUserAuth DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /user/{brand}/{userId}/authorize HTTP/1.1 
Host: dev-api-booster.richemont.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	userId: String,
	brand: String,
	authRequests: 
	[
		{
			posCode: String,
			roles: 
			[
				00000000000000000000000000000000
			]
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}