Postman (Independent Publisher) (Preview)
Postman is a platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Fördős András |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Fördős András |
| Website | https://www.postman.com/ |
| Privacy policy | https://www.postman.com/legal/privacy-policy/ |
| Categories | IT Operations;Productivity |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | Personal API Key for authentication. | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create a workspace |
Creates a new workspace for the authenticated user. |
| Get authenticated user |
Gets information and usage details about the authenticated user. |
| Get collection |
Gets information about a specific postman collection. |
| Get environment |
Gets information about a specific environment. |
| Get workspace |
Gets information about a specific workspace. |
| Import OpenAPI |
Import an OpenAPI (or swagger) definition to your workspace. |
| List all collections |
List all of your subscribed collections. |
| List all environments |
Get information about all of your environments. |
| List all workspaces |
List all workspaces available for the authenticated user. |
Create a workspace
Creates a new workspace for the authenticated user.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | True | string |
Name of the workspace. |
|
Description
|
description | string |
Description of the workspace. |
|
|
Type
|
type | True | string |
Type of the workspace, e.g. 'personal' |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
workspace.id | string |
Unique identifier of the workspace. |
|
Name
|
workspace.name | string |
Name of the workspace. |
Get authenticated user
Gets information and usage details about the authenticated user.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
user.id | integer |
Unique identifier of the user. |
|
Username
|
user.username | string |
Username for the authenticated user. |
|
Email
|
user.email | string |
Email address of the user. |
|
Full name
|
user.fullName | string |
Full name of the user. |
|
Avatar
|
user.avatar | string |
Avatar of the user. |
|
Is Public
|
user.isPublic | boolean |
Boolean, whether the user is public or not. |
|
Operations
|
operations | array of object |
Details of operations and usage for the user. |
|
Name
|
operations.name | string |
Name of the operation. |
|
Limit
|
operations.limit | integer |
Applicable limit for the operation. |
|
Usage
|
operations.usage | integer |
Usage details for the operation. |
|
Overage
|
operations.overage | integer |
Overage details for the operation. |
Get collection
Gets information about a specific postman collection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Collection ID
|
collectionId | True | string |
Unique ID of a Postman collection. |
|
Access Key
|
access_key | string |
Optional value, defining an access key providing read only access to a collection. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Collection
|
collection | object |
Object representing a Postman collection. |
Get environment
Gets information about a specific environment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Environment ID
|
environmentId | True | string |
Unique ID of a Postman environment. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
environment.id | string |
Identifier of the environment. |
|
Name
|
environment.name | string |
Name of the environment. |
|
Owner
|
environment.owner | string |
Identifier of the owner of the environment. |
|
Created At
|
environment.createdAt | string |
Timestamp of the creation of the environment, in UTC format. |
|
Updated At
|
environment.updatedAt | string |
Timestamp of the last update, in UTC format. |
|
variables
|
environment.values | array of object |
Array of environment variable values. |
|
Key
|
environment.values.key | string |
Key of the environment variable. |
|
Value
|
environment.values.value | string |
Value of the environment variable. |
|
Enabled
|
environment.values.enabled | boolean |
Boolean, whether the environment variable is enabled. |
|
Type
|
environment.values.type | string |
Type of the environment variable. |
|
Is Public
|
environment.isPublic | boolean |
Boolean indicating, whether the environment is public or not. |
Get workspace
Gets information about a specific workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace ID
|
workspaceId | True | string |
Unique ID of a Postman workspace. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
workspace.id | string |
Unique identifier of the workspace. |
|
Name
|
workspace.name | string |
Name of the workspace. |
|
Type
|
workspace.type | string |
Type of the workspace, e.g. 'personal'. |
|
Description
|
workspace.description | string |
Description of the workspace. |
|
Visibility
|
workspace.visibility | string |
Visibility of the workspace, e.g. 'personal'. |
|
Created By
|
workspace.createdBy | string |
Unique identifier of user, who created the workspace. |
|
Updated By
|
workspace.updatedBy | string |
Unique identifier of user, who last updated the workspace. |
|
Created At
|
workspace.createdAt | string |
Timestamp of the workspace creation in UTC format. |
|
Updated At
|
workspace.updatedAt | string |
Timestamp of last update in UTC format. |
|
collections
|
workspace.collections | array of object |
Array of collections within the workspace. |
|
Id
|
workspace.collections.id | string |
Unique identifier of the collection within workspace. |
|
Name
|
workspace.collections.name | string |
Name of the collection within workspace. |
|
UID
|
workspace.collections.uid | string |
Globally unique ID of the collection within workspace |
|
environments
|
workspace.environments | array of object |
Array of environments within the workspace. |
|
Id
|
workspace.environments.id | string |
Identifier of the environment within workspace. |
|
Name
|
workspace.environments.name | string |
Name of the environment within workspace. |
|
UID
|
workspace.environments.uid | string |
Globally unique identifier of the environment within workspace. |
|
mocks
|
workspace.mocks | array of object |
Array of mocks within the workspace. |
|
Id
|
workspace.mocks.id | string |
Identifier of the mock within workspace. |
|
Name
|
workspace.mocks.name | string |
Name of the mock within workspace. |
|
UID
|
workspace.mocks.uid | string |
Globally unique identifier of the mock within workspace. |
|
monitors
|
workspace.monitors | array of object |
Array of monitors within the workspace. |
|
Id
|
workspace.monitors.id | string |
Identifier of the monitor within workspace. |
|
Name
|
workspace.monitors.name | string |
Name of the monitor within workspace. |
|
UID
|
workspace.monitors.uid | string |
Globally unique identifier of the monitor within workspace. |
|
apis
|
workspace.apis | array of object |
Array of APIs within the workspace. |
|
Id
|
workspace.apis.id | string |
Identifier of the API within workspace. |
|
Name
|
workspace.apis.name | string |
Name of the API within workspace. |
|
UID
|
workspace.apis.uid | string |
Globally unique identifier of the API within workspace. |
Import OpenAPI
Import an OpenAPI (or swagger) definition to your workspace.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace Id
|
workspace | string |
Optional value, defining the workspace ID to import into. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
collections
|
collections | array of object | |
|
Id
|
collections.id | string |
Identifier of the collection. |
|
Name
|
collections.name | string |
Name of the collection. |
|
UID
|
collections.uid | string |
Global unique identifier of the collection. |
List all collections
List all of your subscribed collections.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace Id
|
workspace | string |
Optional value, defining the workspace ID to check for collections. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Collections
|
collections | array of object |
Array of collections. |
|
Id
|
collections.id | string |
Identifier of the collection. |
|
Name
|
collections.name | string |
Name of the collection. |
|
Owner
|
collections.owner | string |
Unique identifier of the owner of the collection. |
|
Created At
|
collections.createdAt | string |
Timestamp indicating the creation of the collection, in UTC format. |
|
Updated At
|
collections.updatedAt | string |
Timestampt, indicating last update of the collection, in UTC format. |
|
UID
|
collections.uid | string |
Globally unique identifier of the collection. |
|
Is Public
|
collections.isPublic | boolean |
Boolean indicating, whether the collection is public. |
List all environments
Get information about all of your environments.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workspace Id
|
workspace | string |
Optional value, defining the workspace ID to check for environments. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Environments
|
environments | array of object |
Array of environments. |
|
Id
|
environments.id | string |
Identifier of the environment. |
|
Name
|
environments.name | string |
Name of the environment. |
|
Created At
|
environments.createdAt | string |
Timestamp when the environment was created, in UTC format. |
|
Updated At
|
environments.updatedAt | string |
Timestamp when the environment was last updated, in UTC format. |
|
Owner
|
environments.owner | string |
Identifier of the owning user of the environment. |
|
UID
|
environments.uid | string |
Globally unique identifier of the environment. |
|
Is Public
|
environments.isPublic | boolean |
Boolean indicating, whether the environment is public or not. |
List all workspaces
List all workspaces available for the authenticated user.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Type
|
type | string |
Optional, define the type of workspace to return, e.g. 'personal'. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Workspaces
|
workspaces | array of object |
Details of Postman workspaces. |
|
Id
|
workspaces.id | string |
Unique identifier of a workspace. |
|
Name
|
workspaces.name | string |
Name of the workspace. |
|
Type
|
workspaces.type | string |
Type of the workspace, e.g. 'personal'. |
|
Visibility
|
workspaces.visibility | string |
Visibility of the workspace, e.g. 'personal'. |