Mock APIs
Teams
Organisations
Data sources
Database connections
Usage
Access control
Stub Mappings
- GETGet all stub mappings
- POSTCreate a new stub mapping
- DELDelete all stub mappings
- POSTReset stub mappings
- POSTPersist stub mappings
- POSTImport stub mappings
- GETGet stub mapping by ID
- PUTUpdate a stub mapping
- DELDelete a stub mapping
- POSTFind stub mappings matching metadata
- POSTDelete stub mappings matching metadata
Requests
- GETGet all requests in journal
- DELDelete all requests in journal
- GETGet request by ID
- DELDelete request by ID
- POSTEmpty the request journaldeprecated
- POSTCount requests by criteria
- POSTRemove requests by criteria
- POSTDelete requests mappings matching metadata
- POSTFind requests by criteria
- GETFind unmatched requests
OpenAPI
Imports
Organisations
Invite a user to an organisation
POST
/
v1
/
organisations
/
{organisationId}
/
invitations
curl --request POST \
--url https://wmc.wiremockapi.cloud/v1/organisations/{organisationId}/invitations \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"invitation": {
"role": "organisation_admin",
"recipientEmailAddress": "docsmember2@example.com"
}
}'
{
"invitation": {
"id": "neqek",
"senderId": "9gd5l",
"recipientEmailAddress": "tom+docsmember2@wiremock.io",
"newUser": true,
"role": "organisation_admin",
"created": "2024-10-30T19:28:23.802551Z",
"links": {
"self": "/v1/organisations/mgk7g/invitations/neqek"
}
}
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
The ID of the organisation
Required string length:
5 - 10
Example:
"jjl8y"
Body
application/json
Response
201 - application/json
Success
The response is of type object
.
curl --request POST \
--url https://wmc.wiremockapi.cloud/v1/organisations/{organisationId}/invitations \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"invitation": {
"role": "organisation_admin",
"recipientEmailAddress": "docsmember2@example.com"
}
}'
{
"invitation": {
"id": "neqek",
"senderId": "9gd5l",
"recipientEmailAddress": "tom+docsmember2@wiremock.io",
"newUser": true,
"role": "organisation_admin",
"created": "2024-10-30T19:28:23.802551Z",
"links": {
"self": "/v1/organisations/mgk7g/invitations/neqek"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.