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
Mock API versioning
- GETGet a mock API's versions
- GETGet a version by ID
- GETGet all entities in a given version
- GETGet all changes between one version and another
- GETGet the change to an entity between one version and another
- GETGet the contents of a entity at a given version
- POSTRestore the contents of an entity to a given version
- POSTRestore the contents of all mock API entities to a given version
curl --request POST \
--url https://wmc.wiremockapi.cloud/v1/organisations/{organisationId}/invitations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"invitation": {
"role": "organisation_admin",
"recipientEmailAddress": "[email protected]"
}
}
'{
"invitation": {
"id": "neqek",
"senderId": "9gd5l",
"recipientEmailAddress": "[email protected]",
"newUser": true,
"role": "organisation_admin",
"created": "2024-10-30T19:28:23.802551Z",
"links": {
"self": "/v1/organisations/mgk7g/invitations/neqek"
}
}
}Invite a user to an organisation
curl --request POST \
--url https://wmc.wiremockapi.cloud/v1/organisations/{organisationId}/invitations \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"invitation": {
"role": "organisation_admin",
"recipientEmailAddress": "[email protected]"
}
}
'{
"invitation": {
"id": "neqek",
"senderId": "9gd5l",
"recipientEmailAddress": "[email protected]",
"newUser": true,
"role": "organisation_admin",
"created": "2024-10-30T19:28:23.802551Z",
"links": {
"self": "/v1/organisations/mgk7g/invitations/neqek"
}
}
}Path Parameters
The ID of the organisation
5 - 10"jjl8y"
Query Parameters
The search query to filter by. Partially matched against recipient email address.
Body
Show child attributes
Show child attributes
The role of the new user within the organisation.
organisation_admin, organisation_member, team_admin, team_member, mock_api_admin, mock_api_editor, mock_api_user, api_template_admin, api_template_editor, api_template_user, api_template_catalogue_admin, api_template_catalogue_editor, api_template_catalogue_user, data_source_admin, data_source_editor, data_source_user, key_admin, key_editor, key_user "organisation_admin"
The email address of the user being invited.
The ACL ID of the entity to invite the user to join. The role field must be valid for the type of ACL entity the user is being invited to. For instance, if the ACL entity is a team, the provided role must be either team_member or team_admin. If null, the user is not invited to a particular entity, but simply to the organisation.
"8ndxc"
Response
Success
Show child attributes
Show child attributes
"neqek"
The ID of the user sending the invitation.
"9gd5l"
The email address of the user being invited.
Indicates whether the invited user already existed in the system.
true
The role of the new user within the organisation.
organisation_admin, organisation_member, team_admin, team_member, mock_api_admin, mock_api_editor, mock_api_user, api_template_admin, api_template_editor, api_template_user, api_template_catalogue_admin, api_template_catalogue_editor, api_template_catalogue_user, data_source_admin, data_source_editor, data_source_user, key_admin, key_editor, key_user "2024-10-30T19:28:23.802551Z"
The ACL ID of the entity the user is invited to join. If null, the user is not invited to a particular entity, but simply to the organisation.
"8ndxc"