The KORE IAM API manages customer accounts and their relationships — creating accounts, retrieving account hierarchies, and managing platform-specific mappings between parent and child accounts across KORE's product platforms.
openapi: 3.0.0
info:
title: IaM APIs
description: These APIs facilitate the management of customer accounts and their relationships. They support creating accounts, retrieving account hierarchies, and managing platform-specific mappings for parent and associated child accounts. Designed for flexibility and scalability, these APIs ensure efficient handling of account-related data and relationships.
version: 1.0.0
paths:
/v1/platform_account_mappings:
parameters:
- $ref: '#/components/parameters/AuthorizationHeader'
- $ref: '#/components/parameters/AcceptHeader'
- $ref: '#/components/parameters/ContentTypeHeader'
get:
summary: Get Platform Account mappings
tags:
- Accounts
description: This endpoint retrieves the platform mappings for an account and its child accounts.
operationId: fetchAccountMappings
parameters:
- name: account_id
description: The account ID is a unique identifier of your account, which begins with acct_. This optional filter parameter lets you get platforms mapped to a specific account.
in: query
schema:
type: string
example: acct_xxx
responses:
'200':
description: 200 response
content:
application/json:
schema:
$ref: '#/components/schemas/PlatformMapping'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'401':
description: Credentials were not provided and are required to access this resource
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'403':
description: Forbidden error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'409':
description: Conflict error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'422':
description: Unprocessable Content
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'503':
description: Server is temporarily not available
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
/v1/accounts:
parameters:
- $ref: '#/components/parameters/AuthorizationHeader'
- $ref: '#/components/parameters/AcceptHeader'
- $ref: '#/components/parameters/ContentTypeHeader'
post:
summary: Create Child Account
tags:
- Accounts
description: This endpoint is used to create a child account.
operationId: createChild
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccountRequest'
responses:
'200':
description: 200 response
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'401':
description: Credentials were not provided and are required to access this resource
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'403':
description: Forbidden error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'409':
description: Conflict error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'422':
description: Unprocessable Content
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'503':
description: Server is temporarily not available
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
get:
summary: Get All Accounts
tags:
- Accounts
description: This endpoint retrieves the information for an account and its child accounts.
operationId: fetchAllAccounts
parameters:
- name: account_id
in: query
description: The account ID is a unique identifier of your account, which begins with acct_. This optional filter parameter lets you get information for a specific account.
schema:
type: string
example: acct_xxx
required: false
responses:
'200':
description: 200 response
content:
application/json:
schema:
$ref: '#/components/schemas/AllAccounts'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'401':
description: Credentials were not provided and are required to access this resource
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'403':
description: Forbidden error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'409':
description: Conflict error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'422':
description: Unprocessable Content
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
'503':
description: Server is temporarily not available
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
headers:
Access-Control-Allow-Origin:
schema:
type: string
Access-Control-Allow-Methods:
schema:
type: string
Access-Control-Allow-Credentials:
schema:
type: string
Access-Control-Allow-Headers:
schema:
type: string
components:
schemas:
AllAccounts:
type: object
properties:
accounts:
type: array
items:
$ref: '#/components/schemas/Account'
AccountRequest:
type: object
properties:
friendly_name:
type: string
description: Friendly name of the account
description:
type: string
description: Brief description of the account
required:
- friendly_name
Account:
type: object
properties:
id:
type: string
description: Account ID of the child account, which begins with acct_
parent_id:
type: string
description: Account ID of the parent account, which begins with acct_
date_created:
type: string
description: Date and time when the account was created
friendly_name:
type: string
description: Friendly name of the account
status:
type: string
enum:
- ACTIVE
- PENDING
- DEACTIVATED
- SUSPENDED
description: Status of the account
Platform:
type: object
properties:
id:
type: string
description: ID of the account
legacy_account_id:
type: string
description: Platform ID
platform:
type: string
enum:
- twilio
description: Platform Name
ErrorResponse:
type: object
properties:
code:
type: number
description: Error code
example: 20404
message:
type: string
description: Error message
example: The requested resource was not found
more_info:
type: string
description: Error documentation link
example: https://docs.korewireless.com/errors/20404
status:
type: number
description: HTTP status code
example: 404
PlatformMapping:
type: object
properties:
platforms:
type: array
items:
$ref: '#/components/schemas/Platform'
securitySchemes:
Auth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.korewireless.com/api-services/v1/auth/token
scopes: {}
parameters:
AuthorizationHeader:
name: Authorization
in: header
schema:
type: string
AcceptHeader:
name: Accept
in: header
schema:
type: string
ContentTypeHeader:
name: Content-Type
in: header
schema:
type: string
security:
- {}
- Auth: []
x-hideTryItPanel: true
servers:
- url: https://iam.api.korewireless.com
description: PRODUCTION URL