Amazon Business API for Managing Accounts.

Overview

An API for managing Amazon Business accounts.

Version information

Version : 2021-08-30

License information

License : Amazon Software License
License URL : https://aws.amazon.com/asl/

URI scheme

Host : na.business-api.amazon.com
Schemes : HTTPS

Consumes

application/json

Produces

application/json

External Docs

Description : Learn more about Amazon Business.
URL : https://business.amazon.com

Operations

createBusinessUserAccount

Paths

POST /businessAccounts/2021-08-30/businessUserAccount

Operation: createBusinessUserAccount

Description

Creates a new Amazon Business user account with a name and email you specified, and an autogenerated password. Adds the account holder to the specified group with an specified role. The account holder will receive an email message to update the account password.

Parameters

Type	Name	Description	Schema
Body	request required	A request for creating a business user account.	CreateBusinessUserAccountRequest

Responses

HTTP Code	Description	Schema
201	Created an Amazon Business user account with the specified email, group, and role. Sent an email to the account holder for password reset. Headers : `x-amzn-RateLimit-Limit` (string) : The rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : A unique request reference identifier.	CreateBusinessUserAccountResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP Code	Description	Schema
400	The request has missing or invalid parameters and can't be parsed. Headers: `x-amzn-RateLimit-Limit` (string):The rate limit (requests per second) for this operation. `x-amzn-RequestId` (string):A unique request reference identifier.	ErrorList
403	Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: `x-amzn-RequestId` (string):A unique request reference identifier.	ErrorList
404	The resource specified doesn't exist. Headers: `x-amzn-RateLimit-Limit` (string):The rate limit (requests per second) for this operation. `x-amzn-RequestId` (string):A unique request reference identifier.	ErrorList
413	The request size exceeded the maximum accepted size. Headers: `x-amzn-RequestId` (string):A unique request reference identifier.	ErrorList
415	The request payload is in an unsupported format. Headers: `x-amzn-RequestId` (string):A unique request reference identifier.	ErrorList
429	The frequency of requests was greater than allowed. Headers: `x-amzn-RequestId` (string):A unique request reference identifier.	ErrorList
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers: `x-amzn-RequestId` (string):A unique request reference identifier.	ErrorList
503	Temporary overloading or maintenance of the server. Headers: `x-amzn-RequestId` (string):A unique request reference identifier.	ErrorList

Definitions

CreateBusinessUserAccountRequest

A request to create a business user account.

Name	Description	Schema
accountHolder required	The name of the account holder to whom the Amazon Business user account will be created for. The account holder's email shouldn't be associated to an existing Amazon Business user account.	AccountHolder
groupId required	A group identifier that indicates which business group the account holder will be added to. The groupId should already exist before adding a user.	BusinessGroupIdentifier
role required	The business role that will be assigned to the account holder.	BusinessRole
region required	The country or region where the user account will be created.	Region
notificationTypesToSuppress optional	A list of enums that specifies the types of notification to suppress.	< NotificationType > array

CreateBusinessUserAccountResponse

A response indicating that a business user account was created.

Type : object

AccountHolder

An Amazon Business user account holder.

Name	Description	Schema
email required	The email address of the account holder.	string
givenName required	The given name of the account holder.	string
familyName required	The family name of the account holder.	string

BusinessGroupIdentifier

An Amazon Business group identifier

Name	Description	Schema
idType required	The type of group identifier.	enum (IdType)
id required	The value of the identifier.	string

BusinessRole

An Amazon Business user role.

Type : enum

Value	Description
Requisitioner	Buyer role.
PunchoutUser	Punchout catalog user buying role.
Administrator	Administrator role.
Finance	Finance role.
Tech	Tech role.

Region

A country or region where an Amazon Business user account will be created.

Type : enum

Value	Description
DE	amazon.de
FR	amazon.fr
UK	amazon.co.uk
IT	amazon.it
ES	amazon.es
US	amazon.com
CA	amazon.ca
JP	amazon.co.jp

NotificationType

The type of notification to suppress.

Type : enum

Value	Description
EMAIL	Email notifications.

ErrorList

A list of error responses returned when a request is unsuccessful.

Name	Description	Schema
errors required	The list of errors.	< Error > array

Error

An error response that's returned when the request is unsuccessful.

Name	Description	Schema
code required	An error code that identifies the type of error that occurred.	string
message required	A message that describes the error condition.	string
details optional	Additional details to help the customer understand or fix the issue.	string

IdType

The type of group identifier.

Type : enum

Value	Description
GroupId	An Amazon Business auto-generated unique identifier for a group.
GroupTag	A value that identifies which group, within the Amazon Business account, a customer belongs to. Customer sets this in Amazon Business account information. GroupTag is necessary only if the customer account belongs to more than one group.