Create organization API credentials

Creates new API credentials for an organization with the following validations:

Organization Validation:
- Organization must exist
- User must have access to the organization
Role Assignment (required):
- At least one role must be provided
- Roles will be assigned to the API credentials for the organization
- Roles must be valid organization roles (not merchant roles)
- Invalid or missing roles will result in a 400 error
Permission Requirements:
- User must have MERCHANT_DEV_SETTINGS_CREATE_API_KEY permission

Creates new API credentials for an organization with the following validations: 1. **Organization Validation**: - Organization must exist - User must have access to the organization 2. **Role Assignment** (required): - At least one role must be provided - Roles will be assigned to the API credentials for the organization - Roles must be valid organization roles (not merchant roles) - Invalid or missing roles will result in a 400 error 3. **Permission Requirements**: - User must have MERCHANT_DEV_SETTINGS_CREATE_API_KEY permission

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Organization ID

Request

This endpoint expects an object.

namestringRequired

Descriptive name to identify the purpose of the API credentials

roleslist of stringsRequired

Array of role IDs or names to assign to the API credentials for the merchant. Must contain at least 1 role.

Response

Organization API credentials created successfully

apiKeystring

Generated API Key for the merchant

secretstring

Generated Secret for the merchant

Errors

400

Create Organization API Credentials Request Bad Request Error

401

Create Organization API Credentials Request Unauthorized Error

403

Create Organization API Credentials Request Forbidden Error

404

Create Organization API Credentials Request Not Found Error

409

Create Organization API Credentials Request Conflict Error

422

Create Organization API Credentials Request Unprocessable Entity Error

500

Create Organization API Credentials Request Internal Server Error

1	import requests
2
3	url = "https://api-sandbox.koywe.com/api/v1/auth/organizations/organizationId/credentials"
4
5	payload = {
6	"name": "API Key for Koywe integration",
7	"roles": ["MERCHANT_ADMIN", "MERCHANT_VIEWER"]
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

1	{
2	"apiKey": "f7d8e9c0-b1a2-3d4e-5f6g-7h8i9j0k1l2m",
3	"secret": "2af81190b3a153r48a3df3a1eefcc386ca763b99fba53d39666751ffd4e2ae81"
4	}