The Postman API enables you to programmatically access data stored in your Postman account.
Welcome to the PostmanRestapi SDK documentation. This guide will help you get started with integrating and using the PostmanRestapi SDK in your project.
1.01.0.0The Postman API enables you to programmatically access data stored in your Postman account.
This SDK is compatible with the following versions: Python >= 3.7
To get started with the SDK, we recommend installing using pip:
pip install postman-restapi
The PostmanRestapi API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.
When you initialize the SDK, you can set the API key as follows:
PostmanRestapi(
api_key="YOUR_API_KEY",
api_key_header="YOUR_API_KEY_HEADER"
)
If you need to set or update the API key after initializing the SDK, you can use:
sdk.set_api_key("YOUR_API_KEY", "YOUR_API_KEY_HEADER")
Union types allow you to specify that a variable can have more than one type. This is particularly useful when a function can accept multiple types of inputs. The Union type hint is used for this purpose.
You can call service method with an instance of TypeA, TypeB, or a dictionary that can be converted to an instance of either type.
# Model Definition
ParamType = Union[TypeA, TypeB]
# Service Method
def service_method(param: ParamType):
...
## Usage
type_a = TypeA(key="value")
type_b = TypeB(key="value")
sdk.service.service_method(type_a)
sdk.service.service_method(type_b)
sdk.service.service_method({"key": "value"})
You cannot create an instance of a Union type itself. Instead, pass an instance of one of the types in the Union, or a dictionary that can be converted to one of those types.
The SDK provides various services to interact with the API.
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
| Name | Description |
|---|---|
| InvoicesAccountInfo | Information about the account. |
| GetAccountInvoices | |
| GetAccountInvoicesStatus | |
| GetApis | Information about the API schema. |
| Accept | |
| CreateApiRequest | Information about the API. |
| CreateApiOkResponse | The API's base data schema. |
| GetApi | |
| GetApiInclude | |
| UpdateApiRequest | Information about the API. |
| UpdateApiOkResponse | Information about the API. |
| AddApiCollectionRequest | |
| AddApiCollectionOkResponse | |
| SyncCollectionWithSchema | |
| CommentResponse | |
| CommentCreateUpdate | Information about the comment. |
| CommentCreatedUpdated | |
| CreateApiSchemaRequest | Information about the API schema. |
| CreateApiSchemaOkResponse | Information about the created API schema. |
| GetApiSchema | |
| GetApiSchemaFiles | Information about the schema files and its meta information. |
| GetApiSchemaFileContents | Information about the schema file. |
| CreateUpdateApiSchemaFileRequest | Information about schema file. |
| CreateUpdateApiSchemaFileOkResponse | Information about the schema file. |
| GetStatusOfAnAsyncTask | |
| GetApiVersions | Information about the API's versions. |
| CreateApiVersionRequest | |
| CreateApiVersionAcceptedResponse | |
| GetApiVersion | |
| UpdateApiVersionRequest | Information about the API version. |
| UpdateApiVersionOkResponse | |
| TagGetPut | |
| TagUpdateTags | |
| GetTaggedEntities | |
| AscDescDefaultDesc | |
| GetTaggedEntitiesEntityType | |
| GetAuditLogs | |
| GetCollections | |
| CollectionsCreateCollectionRequest | |
| CreateCollectionOkResponse | |
| CreateCollectionForkRequest | |
| CreateCollectionForkOkResponse | |
| MergeCollectionForkRequest | |
| MergeCollectionForkOkResponse | |
| GetCollection | |
| GetCollectionModel | |
| PutCollectionRequest | |
| PutCollectionOkResponse | |
| PatchCollectionRequest | |
| PatchCollectionOkResponse | |
| DeleteCollection | |
| GetCollectionsForkedByUser | |
| AscDesc | |
| GetCollectionForks | |
| PullCollectionChanges | |
| GetCollectionPullRequests | |
| PullRequestCreate | Information about the pull request. |
| PullRequestCreated | |
| GetCollectionRoles | Information about the collection's roles. |
| UpdateCollectionRoles | |
| GetSourceCollectionStatus | |
| TransformCollectionToOpenApi | |
| Format | |
| TransferCollectionItems | |
| TransferCollectionItems200Error | |
| CreateCollectionFolder | |
| CreateCollectionRequestOkResponse | |
| CreateCollectionResponse | |
| GetCollectionFolder | |
| UpdateCollectionFolder | |
| DeleteCollectionFolder | |
| GetCollectionRequest | |
| UpdateCollectionRequest | |
| DeleteCollectionRequest | |
| GetCollectionResponse | |
| UpdateCollectionResponse | |
| DeleteCollectionResponse | |
| DetectedSecretsQueriesRequest | |
| DetectedSecretsQueriesOkResponse | |
| UpdateDetectedSecretResolutionsRequest | |
| UpdateDetectedSecretResolutionsOkResponse | |
| GetSecretsLocations | |
| GetSecretTypes | |
| GetEnvironments | |
| CreateEnvironmentRequest | |
| CreateEnvironmentOkResponse | |
| GetEnvironment | |
| UpdateEnvironmentRequest | |
| UpdateEnvironmentOkResponse | |
| DeleteEnvironment | |
| GetEnvironmentForks | |
| GetEnvironmentForksSort | |
| ForkEnvironmentRequest | |
| ForkEnvironmentOkResponse | |
| MergeEnvironmentForkRequest | |
| MergeEnvironmentForkOkResponse | |
| PullEnvironmentRequest | |
| PullEnvironmentOkResponse | |
| ImportExportFile | |
| ImportOpenApiDefinitionOkResponse | |
| GetAuthenticatedUser | |
| GetMocks | |
| CreateMock | |
| MockCreateUpdate | |
| GetMock | |
| UpdateMock | |
| DeleteMock | |
| GetMockCallLogs | |
| GetMockCallLogsSort | |
| PublishMock | |
| UnpublishMock | |
| GetMockServerResponses | Information about the server response. |
| CreateMockServerResponse | |
| UpdateMockServerResponse | |
| DeleteMockServerResponse | Information about the deleted server response. |
| GetMonitors | |
| CreateMonitorRequest | |
| CreateMonitorOkResponse | |
| GetMonitor | |
| UpdateMonitorRequest | |
| UpdateMonitorOkResponse | |
| DeleteMonitor | |
| RunMonitor | |
| GetPanElementsAndFolders | |
| GetAllElementsAndFoldersSort | |
| GetAllElementsAndFoldersType | |
| PostPanElementOrFolderRequest | |
| UpdatePanElementOrFolderRequest | |
| UpdatePanElementOrFolderElementType | |
| DeletePanElementOrFolder | |
| GetAllPanAddElementRequests | |
| GetAllPanAddElementRequestsStatus | |
| PrivateApiNetworkRespondPanElementAddRequestRequest_1 | |
| RespondPanElementAddRequestOkResponse | |
| PullRequestGet | |
| PullRequestUpdate | |
| PullRequestUpdated | |
| SchemaSecurityValidationRequest | |
| SchemaSecurityValidationOkResponse | |
| GetScimGroupResources | |
| CreateScimGroupRequest | |
| CreateScimGroupCreatedResponse | |
| GetScimGroupResource | |
| ScimUpdateGroupRequest | |
| ScimUpdateGroupOkResponse | |
| GetScimResourceTypes | |
| GetScimServiceProviderConfig | Information about Postman's SCIM API configurations and supported operations. |
| GetScimUserResources | |
| CreateScimUserRequest | |
| CreateScimUserCreatedResponse | |
| GetScimUserResourceOkResponse | |
| UpdateScimUser | |
| UpdateScimUserState | |
| CreateWebhookRequest | |
| CreateWebhookOkResponse | |
| GetWorkspaces | |
| GetWorkspacesType | |
| GetWorkspacesInclude | |
| CreateWorkspaceRequest | |
| CreateWorkspaceOkResponse | |
| GetWorkspaceRoles | |
| GetWorkspace | |
| UpdateWorkspaceRequest | |
| UpdateWorkspaceOkResponse | |
| DeleteWorkspace | |
| GetWorkspaceGlobalVariables | Information about the workspace's global variables. |
| UpdateWorkspaceGlobalVariablesRequest | |
| UpdateWorkspaceGlobalVariablesOkResponse | Information about the workspace's updated global variables. |
| UpdateWorkspaceRolesRequest | |
| UpdateWorkspaceRolesOkResponse | |
| SalesChannel | The sales channel from which the account was created: - SELF_SERVE — The user purchased the account plan.- SALES_SERVE — The account was purchased through the Postman sales team process. |
| Slots | Information about the team's slots. |
| InvoiceData | Information about the invoice. |
| TotalAmount | Information about the invoice's total billed amount. |
| Links | A JSON API spec object containing hypermedia links. |
| Web | An object containing web-based account references. |
| GetApisApis | The API's base data schema. |
| GetApisMeta | The response's meta information for paginated results. |
| GetApi_1 | The API's base data schema. |
| GetApi_2 | |
| GitInfo | Information about the API's Git repository integration. |
| GetApi_2Schemas | Information about the schema. |
| GetApi_2Versions | Information about the version. |
| GetApi_2Collections | Information about the collection. |
| AddApiCollection_1 | |
| AddApiCollection_2 | |
| AddApiCollection_3 | |
| AddApiCollection_1Data | |
| AddApiCollection_1OperationType | The COPY_COLLECTION method. |
| AddApiCollection_2OperationType | The GENERATE_FROM_SCHEMA method. |
| AddApiCollection_3Data | Information about the collection's contents, such as requests and responses. For a complete list of values, refer to the collection.json schema file. |
| AddApiCollection_3OperationType | The CREATE_NEW method. |
| DataInfo | Information about the collection. |
| InfoSchema | The collection's schema format. |
| CommentResponseData | Information about the comment. |
| CommentCreateUpdateTags | Information about users tagged in the body comment. |
| UserName | An object that contains information about the tagged user. The object's name is the user's Postman username. For example, @user-postman. |
| UserNameType | The user value. |
| CommentCreatedUpdatedData | |
| CreateApiSchemaType_1 | The schema's type. |
| CreateApiSchemaFiles_1 | |
| FilesRoot | Information about the schema's root file. |
| Enabled | If true, tag the file as the root file. The root tag is only allowed for protobuf specifications. |
| CreateApiSchemaType_2 | The schema's type. |
| CreateApiSchemaFiles_2 | Information about the schema file. |
| GetApiSchema_1 | Information about the schema. |
| GetApiSchema_2 | Information about the schema. |
| GetApiSchema_1Files | Information about the schema's files. The response is paginated and limited to one page. |
| FilesData | Information about the schema file. |
| FilesMeta | |
| GetApiSchemaFilesMeta | The schema's non-standard meta information. |
| GetApiSchemaFilesFiles | Information about the schema file. |
| CreateUpdateApiSchemaFileRoot | Information about the schema's root file. This tag only applies to protobuf specifications. |
| GetStatusOfAnAsyncTaskMeta | The response's non-standard meta information. |
| GetStatusOfAnAsyncTaskStatus | The task's current status. |
| Details | |
| MetaModel | The model for which the task is performing the operation. |
| Action | The task's action. |
| Details_1 | Information about the task's resources. |
| Details_2 | Information about the error that occurred during the task's processing. |
| Details_1Resources | |
| Error | |
| GetApiVersionsMeta | The response's meta information for paginated results. |
| GetApiVersionsVersions | Information about the API version. |
| CreateApiVersion_1 | Information about the API version. |
| CreateApiVersion_2 | Information about the API version. |
| CreateApiVersion_3 | Information about the API version. |
| CreateApiVersion_1Schemas | Information about the schema. |
| CreateApiVersion_1Collections | Information about the collection. |
| CreateApiVersion_2Schemas | Information about the schema. |
| CreateApiVersion_2Collections | Information about the collection. |
| CreateApiVersion_3Schemas | Information about the schema. |
| CreateApiVersion_3Collections | Information about the collection. |
| Version | Information about the API version. |
| VersionSchemas | |
| VersionCollections | |
| TagGetPutTags | Information about the tag. |
| TagUpdateTagsTags | Information about the tag. |
| GetTaggedEntitiesData | An object containing the paginated elements. |
| GetTaggedEntitiesMeta | The response's pagination information. |
| Entities | |
| EntitiesEntityType | The type of Postman element. |
| Trails | |
| TrailsData | |
| Actor | Information about the user who preformed the audit event. |
| DataUser | Information about the user. |
| DataTeam | The user's team information. |
| GetCollectionsCollections | Information about the collection. |
| CollectionsFork | If the collection is forked, the fork's information. |
| CreateCollectionCollection_1 | For a complete list of values, refer to the collection.json schema file. |
| CollectionInfo_1 | An object that contains basic information about the collection. For a complete list of values, refer to the definitions.info entry in the collection.json schema file. |
| CollectionItem | |
| CreateCollectionCollection_2 | |
| CreateCollectionForkCollection | Information about the forked collection. |
| CollectionFork | Information about the collection's fork. |
| Strategy | The fork's merge strategy: - deleteSource — Merge the changes into the parent collection. After the merge process is complete, Postman deletes the fork. You must have Editor access to both the parent and forked collections.- updateSourceWithDestination — Merge the changes into the parent collection. Any differences in the parent collection are also made to the fork. |
| MergeCollectionForkCollection | |
| PutCollectionCollection_1 | For a complete list of values, refer to the collection.json schema file. |
| PutCollectionCollection_2 | |
| PatchCollectionCollection_1 | |
| CollectionInfo_2 | An object that contains the collection's updated name and description. |
| PatchCollectionCollection_2 | |
| DeleteCollectionCollection | Information about the deleted collection. |
| GetCollectionsForkedByUserData | Information about the forked collection. |
| GetCollectionsForkedByUserMeta | The response's meta information for paginated results. |
| GetCollectionForksData | Information about the forked collection. |
| GetCollectionForksMeta | The response's meta information for paginated results. |
| PullCollectionChangesCollection | Information about the updated collection fork. |
| GetCollectionPullRequestsData | Information about the pull request. |
| DataStatus | The pull request's current status. |
| Group | Information about the group role. |
| GetCollectionRolesTeam | Information about the team role. |
| GetCollectionRolesUser | Information about the user role. |
| GroupRole | The role type: - VIEWER — Can view, fork, and export collections.- EDITOR — Can edit collections directly. |
| TeamRole | The role type: - VIEWER — Can view, fork, and export collections.- EDITOR — Can edit collections directly. |
| UserRole | The role type: - VIEWER — Can view, fork, and export collections.- EDITOR — Can edit collections directly. |
| UpdateCollectionRolesRoles | |
| RolesOp | The operation to perform on the path. |
| RolesPath_1 | The resource to perform the action on. |
| RolesValue_1 | Information about the updated role. |
| ValueRole_1 | The role type: - VIEWER — Can view, fork, and export collections.- EDITOR — Can edit collections directly. |
| GetSourceCollectionStatusCollection | |
| CollectionUid | Information about the forked collection. The object's name is the forked collection's UID (userId-collectionId). |
| Mode | The transfer operation to perform. |
| Target | Information about the item transfer's destination location. |
| Location | The transferred items' placement in the target destination: - For start or end — Do not include the model and id values.- For before or after — Include the model and id properties. |
| TargetModel | The collection, folder, or request the items will be transferred to. For response transfers, use the request value. |
| Position | The transferred item's position within the destination object. |
| DeleteCollectionFolderData | The folder's information. |
| DeleteCollectionRequestData | The request's information. |
| DeleteCollectionResponseData | The response's information. |
| Statuses | The secret resolution status type: - FALSE_POSITIVE — The discovered secret is not an actual secret.- REVOKED — The secret is valid, but the user rotated their key to resolve the issue.- ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it. |
| WorkspaceVisiblities | The type of visibility setting. |
| DetectedSecretsQueriesData | Information about the secret finding. |
| DetectedSecretsQueriesMeta | The response's meta information for paginated results. |
| DataResolution | The secret's current status: - ACTIVE — The secret is active.- FALSE_POSITIVE — The discovered secret is not an actual secret.- REVOKED — The secret is valid, but the user rotated their key to resolve the issue.- ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it. |
| DataWorkspaceVisibility | The workspace's visibility setting. |
| UpdateSecretResolutionsResolution_1 | The secret's updated resolution status: - FALSE_POSITIVE — The discovered secret is not an actual secret.- REVOKED — The secret is valid, but the user rotated their key to resolve the issue.- ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it. |
| History | |
| UpdateSecretResolutionsResolution_2 | The secret's current resolution status: - ACTIVE — The secret is active.- FALSE_POSITIVE — The discovered secret is not an actual secret.- REVOKED — The secret is valid, but the user rotated their key to resolve the issue.- ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it. |
| HistoryResolution | The secret's updated resolution status: - ACTIVE — The secret is active.- FALSE_POSITIVE — The discovered secret is not an actual secret.- REVOKED — The secret is valid, but the user rotated their key to resolve the issue.- ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it. |
| GetSecretsLocationsData | Information about the secret finding locations. |
| GetSecretsLocationsMeta | |
| DataResourceType | The type of resource in which the secret was detected. |
| ActivityFeed | |
| ActivityFeedStatus | The secret's current resolution status: - ACTIVE — The secret is active.- FALSE_POSITIVE — The discovered secret is not an actual secret.- REVOKED — The secret is valid, but the user rotated their key to resolve the issue.- ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it. |
| GetSecretTypesData | Information about the secret type. |
| GetSecretTypesMeta | |
| DataType | The origin of the secret type: - DEFAULT — Supported by default in Postman.- TEAM_REGEX — A custom regex added by an Admin or Super Admin user in the Configure Alerts section of the Team Settings interface. |
| GetEnvironmentsEnvironments | |
| CreateEnvironmentEnvironment_1 | |
| EnvironmentValues_1 | |
| ValuesType_1 | The variable type. |
| CreateEnvironmentEnvironment_2 | |
| GetEnvironmentEnvironment | |
| EnvironmentValues_2 | |
| ValuesType_2 | The variable type. |
| UpdateEnvironmentEnvironment_1 | |
| EnvironmentValues_3 | |
| ValuesType_3 | The variable type. |
| UpdateEnvironmentEnvironment_2 | |
| DeleteEnvironmentEnvironment | |
| GetEnvironmentForksData | Information about the forked environment. |
| GetEnvironmentForksMeta | The response's meta information for paginated results. |
| ForkEnvironmentEnvironment | Information about the forked environment. |
| MergeEnvironmentForkEnvironment | Information about the merged environment. |
| PullEnvironmentEnvironment | Information about the merged environment. |
| JsonSchema | |
| JsonStringified | |
| JsonSchemaType | The OpenAPI definition type. |
| JsonStringifiedType | The OpenAPI definition type. |
| ImportExportFileType | The file type value. |
| ImportOpenApiDefinitionCollections | |
| GetAuthenticatedUserUser | Information about the authenticated user. |
| GetAuthenticatedUserOperations | |
| GetMocksMocks | Information about the mock servers. |
| MocksConfig | Information about the mock server's configuration. |
| Delay | Information about the mock server's simulated network delay settings. This returns a null value if there are no configured network delay settings. |
| DelayType | The type of simulated delay value: - fixed — The delay value is a fixed value. |
| Preset | The simulated fixed network delay value: - 1 — 2G (300 ms).- 2 — 3G (100 ms).The object does not return this value for custom delay values. |
| CreateMockMock | |
| MockCreateUpdateMock | Information about the mock server. |
| GetMockMock | |
| MockConfig_1 | Information about the mock server's configuration. |
| UpdateMockMock | |
| MockConfig_2 | The mock server's configuration settings. |
| DeleteMockMock | Information about the mock server. |
| CallLogs | Information about the mock server's server responses. |
| GetMockCallLogsMeta | The response's non-standard meta information. |
| CallLogsRequest | The server response's request information. |
| CallLogsResponse | The server response's response information. |
| RequestHeaders | The request's headers. |
| RequestBody | The request's body information. |
| ResponseHeaders | The response's headers. |
| ResponseBody | The response's body information. |
| Description | The response header's description information. |
| PublishMockMock | |
| UnpublishMockMock | |
| CreateMockServerResponseServerResponse | |
| ServerResponseHeaders_1 | |
| ServerResponseLanguage_1 | The server response's body language type. |
| UpdateMockServerResponseServerResponse | |
| ServerResponseHeaders_2 | Information about they key-value pair. |
| ServerResponseLanguage_2 | The server response's body language type. |
| DeleteMockServerResponseHeaders | |
| DeleteMockServerResponseLanguage | The server response's body language type. |
| GetMonitorsMonitors | |
| CreateMonitorMonitor_1 | |
| MonitorSchedule_1 | Information about the monitor's schedule. |
| CreateMonitorMonitor_2 | |
| GetMonitorMonitor | |
| LastRun | Information about the monitor's previous run. |
| Notifications | Information about the monitor's notification settings. |
| Options | Information about the monitor's option settings. |
| MonitorSchedule_2 | Information about the monitor's schedule. |
| LastRunStats | Information about the monitor's stats. |
| StatsAssertions_1 | Information about the monitor's assertions. |
| StatsRequests_1 | Information about the monitor's requests. |
| OnError | |
| OnFailure | |
| UpdateMonitorMonitor_1 | |
| MonitorSchedule_3 | Information about the monitor's schedule. |
| UpdateMonitorMonitor_2 | |
| DeleteMonitorMonitor | |
| Run | Information about the monitor run. |
| RunInfo | Information about the monitor. |
| RunStats | Information about the monitor run's stats. |
| Executions | |
| StatsAssertions_2 | The monitor run's assertions stats. |
| StatsRequests_2 | The monitor run's request stats. |
| ExecutionsItem | Information about the executed item. |
| ExecutionsRequest | Information about the monitor run's requests. |
| ExecutionsResponse | Information about the monitor run's response. |
| Elements | |
| Folders | |
| GetPanElementsAndFoldersMeta | The response's non-standard meta information. |
| PanCreateApi | |
| PanCreateCollection | |
| PanCreateWorkspace | |
| PanCreateFolder | |
| PanCreateApiApi | |
| PanCreateCollectionCollection | |
| PanCreateWorkspaceWorkspace | |
| PanCreateFolderFolder | |
| PanElementCreated | Information about the Private API Network element. |
| PanFolderCreated | Information about the Private API Network folder. |
| UpdatePanApi | |
| UpdatePanCollection | |
| UpdatePanWorkspace | |
| UpdatePanFolder | |
| UpdatePanApiApi | |
| UpdatePanCollectionCollection | |
| CollectionEnvironments | The collection's updated environments. |
| UpdatePanWorkspaceWorkspace | |
| UpdatePanFolderFolder | |
| DeletePanElementOrFolderElementType | The Private API Network element type. The name of the object is the element api, collection, workspace, or folder type. |
| GetAllPanAddElementRequestsRequests | |
| GetAllPanAddElementRequestsMeta | The response's non-standard meta information. |
| RequestsStatus | The request's status. |
| RequestsElement | Information about the requested element. |
| RequestsResponse | Information about the response to the request. This object only returns when the network manager denied a request with a message. |
| ElementType_1 | The element type. |
| RespondPanElementAddRequestResponse | The response to the user's request. |
| RespondPanElementAddRequestStatus | The request's status. |
| RespondPanElementAddRequestRequest_2 | |
| RequestResponse | Information about the response to the element's request. This object only returns when the network manager denied a request with a message. |
| RequestElement | Information about the requested element. |
| RequestStatus | The request's status. |
| ElementType_2 | The element type. |
| Source | Information about the pull request's source (parent) element. |
| Destination | Information about the pull request destination element. |
| Merge | Information about the current progress of the pull request's merge. |
| Reviewers | |
| MergeStatus | The pull request's current merge status: - inactive — There is no merge in progress.- inprogress — The pull request is currently merging.- failed — The pull request's merge failed. |
| PullRequestUpdatedStatus | The pull request's status. |
| SchemaSecurityValidationSchema | |
| SchemaLanguage | The definition format. |
| SchemaType | The definition type. |
| ScimGroupResource | The SCIM group resource object. |
| ScimGroupResourceMembers | Information about the group's members. |
| ScimGroupResourceMeta | The response's non-standard meta information. |
| CreateScimGroupMembers_1 | An object containing the SCIM users to assign to the group. |
| CreateScimGroupMembers_2 | An object containing the group's assigned SCIM members. |
| CreateScimGroupMeta | The response's non-standard meta information. |
| GetScimGroupResourceMembers | |
| GetScimGroupResourceMeta | The response's non-standard meta information. |
| ScimUpdateGroupOperations | |
| OperationsOp_1 | The operation to perform. |
| OperationsValue_1 | The performed operation's value. |
| ScimUpdateGroupMeta | The response's non-standard meta information. |
| SchemaExtensions | |
| Patch | Information about patch configuration. |
| Bulk | Information about bulk configuration. |
| Filter | Information about the filter configuration. |
| ChangePassword | Information about the change password configuration. |
| GetScimServiceProviderConfigSort | Information about the sort configuration. |
| AuthenticationSchemes | Information about the scheme. |
| Etag | Information about the entity tag (Etag) HTTP response header configuration. |
| GetScimServiceProviderConfigMeta | The response's non-standard meta information. |
| Resources | The SCIM user resource object. |
| ScimUserResourceName_1 | Information about the Postman team member. |
| ScimUserResourceMeta_1 | The response's non-standard meta information. |
| CreateScimUserName_1 | Information about the user's name. |
| CreateScimUserName_2 | |
| CreateScimUserMeta | The response's non-standard meta information. |
| MetaResourceType | The SCIM resource type. |
| ScimUserResourceName_2 | Information about the Postman team member. |
| ScimUserResourceMeta_2 | The response's non-standard meta information. |
| UpdateScimUserName | Information about the user's name. |
| UpdateScimUserStateOperations | |
| OperationsOp_2 | The operation to perform. |
| OperationsValue_2 | The performed operation's value. |
| CreateWebhookWebhook_1 | |
| CreateWebhookWebhook_2 | |
| Workspaces | Information about the workspace. |
| WorkspacesType | The type of workspace. |
| WorkspacesVisibility | The workspace's visibility. Visibility determines who can access the workspace: - personal — Only you can access the workspace.- team — All team members can access the workspace.- private — Only invited team members can access the workspace (Professional and Enterprise plans only).- public — Everyone can access the workspace.- partner — Only invited team members and partners can access the workspace (Professional and Enterprise plans only). |
| CreateWorkspaceWorkspace_1 | Information about the workspace. |
| WorkspaceType_1 | The type of workspace: - personal- private — Private workspaces are available on Postman Professional and Enterprise plans.- public- team- partner — Partner Workspaces are available on Postman Professional and Enterprise plans). |
| CreateWorkspaceWorkspace_2 | Information about the created workspace. |
| GetWorkspaceRolesRoles | Information about the workspace's user roles. |
| RolesUser | Information about the user role. |
| Usergroup | Information about the user group in the workspace. |
| GetWorkspaceWorkspace | Information about the workspace. |
| WorkspaceType_2 | The type of workspace. |
| WorkspaceVisibility | The workspace's visibility. Visibility determines who can access the workspace: - personal — Only you can access the workspace.- team — All team members can access the workspace.- private — Only invited team members can access the workspace (Professional and Enterprise plans only).- public — Everyone can access the workspace.- partner — Only invited team members and partners can access the workspace (Professional and Enterprise plans only). |
| WorkspaceCollections | Information about the collection. |
| WorkspaceEnvironments | Information about the environment. |
| WorkspaceMocks | Information about the mock server. |
| WorkspaceMonitors | Information about the monitor. |
| WorkspaceApis | Information about the API. |
| UpdateWorkspaceWorkspace_1 | |
| WorkspaceType_3 | The new workspace visibility type. This property does not support the following workspace visibility changes: - private to public, public to private, and private to personal for Free and Basic plans.- public to personal for team users. |
| UpdateWorkspaceWorkspace_2 | Information about the updated workspace. |
| DeleteWorkspaceWorkspace | Information about the deleted workspace. |
| GlobalVariable | Information about the global variable. |
| GlobalVariableType | The type of variable. |
| UpdateWorkspaceRolesRoles_1 | |
| RolesPath_2 | The resource to perform the action on. |
| RolesValue_2 | Information about the updated user or user group role. |
| ValueRole_2 | The workspace role's ID: - 1 — Viewer. Can view, fork, and export workspace resources.- 2 — Editor. Can create and edit workspace resources.- 3 — Admin. Can manage workspace details and members. |
| UpdateWorkspaceRolesRoles_2 | |
| DisplayName | The role's display name. |
This SDK is licensed under the MIT License.
See the LICENSE file for more details.
FAQs
The Postman API enables you to programmatically access data stored in your Postman account.
We found that postman-restapi demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.