API Overview Resources Schemas

Customer credentials

Access to customer credentials

post customer credential

Create customer credential

POST /orgs/{org_id}/customers/{customer_id}/credentials

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier
body	body	Credential	true	‘none’

Request body - instance of Credential

1
2
3


{
  "username": "username@masmovil.com"
}

Name	Type	Required	Description
username	string	true	Username

Request example

1
2
3
4
5
6
7
8
9



curl -X POST https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'username': 'username@masmovil.com'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Credential added successfully	CredentialCreated
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
409	Conflict	Conflict	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

get customer credentials

Return customer credentials

GET /orgs/{org_id}/customers/{customer_id}/credentials

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Customer credentials returned successfully	Credentials
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

delete customer credential

Delete customer credential given its id

DELETE /orgs/{org_id}/customers/{customer_id}/credentials/{credential_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier
credential_id	path	string(uuid)	true	Credential identifier

Request example

1
2
3
4
5



curl -X DELETE https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/credentials/028076fa-c264-42bb-9983-8872a576be28 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
204	No Content	successful operation	None
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
405	Method Not Allowed	Method not allowed	None
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Endpoints

Accounts

Customers