ApiSecurityService

A list of all methods in the ApiSecurityService service. Click on the method name to view detailed information about that method.

Methods	Description
schemaSecurityValidation	Performs an analysis on the given definition and returns any issues based on your predefined rulesets. This endpoint can help you understand the violations' impact and offers solutions to help you resolve any errors. You can include this endpoint to your CI/CD process to automate schema validation. For more information, see our Rule violations in the API definition documentation. Note: - The maximum allowed size of the definition is 10 MB. - You must import and enable Postman's OWASP security rules in Postman for this endpoint to return any security rule violations.

Methods

Description

schemaSecurityValidation

Performs an analysis on the given definition and returns any issues based on your predefined rulesets. This endpoint can help you understand the violations' impact and offers solutions to help you resolve any errors. You can include this endpoint to your CI/CD process to automate schema validation. For more information, see our Rule violations in the API definition documentation. Note: - The maximum allowed size of the definition is 10 MB. - You must import and enable Postman's OWASP security rules in Postman for this endpoint to return any security rule violations.

schemaSecurityValidation

HTTP Method: POST
Endpoint: /security/api-validation

Parameters

Name	Type	Required	Description
body	SchemaSecurityValidationRequest	❌	The request body.

Return Type

SchemaSecurityValidationOkResponse

Example Usage Code Snippet

import { PostmanClient, SchemaSecurityValidationRequest } from 'postman_client';

(async () => {
  const postmanClient = new PostmanClient({
	apiKey: 'YOUR_API_KEY'});

  const schemaLanguage = SchemaLanguage.JSON;

const schemaType = SchemaType.OPENAPI3;

const schemaSecurityValidationSchema: SchemaSecurityValidationSchema = {
  language: schemaLanguage,
  schema: "{"openapi":"3.0.0","info":{"version":"1","title":"temp","license":{"name":"MIT"}},"servers":[{"url":"https://petstore.swagger.io/v1"}],"paths":{"/user":{"get":{"summary":"Details about a user","operationId":"listUser","tags":["user"],"parameters":[{"name":"id","in":"query","description":"ID of the user","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Details about a user","headers":{"x-next":{"description":"A link to the next page of responses","schema":{"type":"string"}}},"content":{"application/json":{"schema":{$ref:"#/components/schemas/User"}}}},"default":{"description":"unexpected error","content":{"application/json":{"schema":{$ref:"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"User":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"tag":{"type":"string"}}},"Error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}}},"security":[{"BasicAuth":[]}]}",
  type: schemaType
};

const input: SchemaSecurityValidationRequest = {
  schema: schemaSecurityValidationSchema
};

  const { data } = await postmanClient.apiSecurity.schemaSecurityValidation(
  input
);

  console.log(data);
})();

Build Your Own SDKs with liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →

schemaSecurityValidation​

Build Your Own SDKs with liblab

schemaSecurityValidation