new RequestAuth(options, parentopt)
A Postman Auth definition that comprehensively represents different types of auth mechanisms available.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
RequestAuth.definition | Pass the initial definition of the Auth. |
|
parent |
Property | PropertyList |
<optional> |
optionally pass the parent of this auth. aides variable resolution. |
- Source:
Example
var auth = new RequestAuth({
type: 'digest',
basic: [
{ key: "username", value: "postman" },
{ key: "password", value: "secrets" }
],
digest: [
{ key: "nonce", value: "aef54cde" },
{ key: "realm", value: "items.x" }
]
});
// change the selected auth
auth.use('basic');
Extends
Members
disabled :Boolean
This (optional) flag denotes whether this property is disabled or not. Usually, this is helpful when a property is part of a PropertyList. For example, in a PropertyList of Headers, the ones that are disabled can be filtered out and not processed.
Type:
- Boolean
- Inherited From:
- Source:
id :String
The id
of the property is a unique string that identifies this property and can be used to refer to
this property from relevant other places. It is a good practice to define the id or let the system
auto generate a UUID if one is not defined for properties that require an id
.
Type:
- String
- Inherited From:
- Source:
name :String
A property can have a distinctive and human-readable name. This is to be used to display the name of the
property within Postman, Newman or other runtimes that consume collection. In certain cases, the absence
of name might cause the runtime to use the id
as a fallback.
Type:
- String
- Inherited From:
- Source:
Methods
(static) isValidType(type) → {Boolean}
Determines whether an authentication type name is valid or not
Parameters:
Name | Type | Description |
---|---|---|
type |
String |
- Source:
Returns:
- Type
- Boolean
clear(type)
Clears the definition of an auth type.
Parameters:
Name | Type | Description |
---|---|---|
type |
String |
- Source:
describe(content, typeopt)
This function allows to describe the property for the purpose of detailed identification or documentation
generation. This function sets or updates the description
child-property of this property.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
content |
String | The content of the description can be provided here as a string. Note that it is expected
that if the content is formatted in any other way than simple text, it should be specified in the subsequent
|
||
type |
String |
<optional> |
"text/plain" | The type of the content. |
- Inherited From:
- Source:
Example
var Collection = require('postman-collection').Collection,
mycollection;
// create a blank collection
myCollection = new Collection();
myCollection.describe('Hey! This is a cool collection.');
console.log(myCollection.description.toString()); // read the description
findInParents(property, customizeropt) → {*|undefined}
Tries to find the given property locally, and then proceeds to lookup in each parent,
going up the chain as necessary. Lookup will continue until customizer
returns a truthy value. If used
without a customizer, the lookup will stop at the first parent that contains the property.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
property |
String | ||
customizer |
function |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- * | undefined
forEachParent(options, iterator)
Invokes the given iterator for every parent in the parent chain of the given element.
Parameters:
Name | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | A set of options for the parent chain traversal. Properties
|
||||||||||
iterator |
function | The function to call for every parent in the ancestry chain. |
- Inherited From:
- Source:
- To Do:
-
- Cache the results
meta() → {*}
Returns the meta keys associated with the property
- Inherited From:
- Source:
Returns:
- Type
- *
parameters() → {VariableList}
Returns the parameters of the selected auth type
- Source:
Returns:
- Type
- VariableList
parent() → {*|undefined}
Returns the parent of item
- Inherited From:
- Source:
Returns:
- Type
- * | undefined
toJSON()
Returns the JSON representation of a property, which conforms to the way it is defined in a collection. You can use this method to get the instantaneous representation of any property, including a Collection.
- Inherited From:
- Source:
update(options, typeopt)
Update the parameters of a specific authentication type. If none is provided then it uses the one marked as to be used.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options |
VariableList | Array | Object | |||
type |
String |
<optional> |
this.type |
- Source:
use(type, options)
Sets the authentication type to be used by this item.
Parameters:
Name | Type | Description |
---|---|---|
type |
String | |
options |
VariableList | Array | Object | note that options set here would replace all existing options for the particular auth |
- Source:
Type Definitions
definition
This defines the definition of the authentication method to be used.
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
type |
String |
<optional> |
The Auth type to use. Check the names in AuthTypes |
- Source:
Example
{
"type": "basic",
"basic": [
{ "key": "username", "value": "postman" },
{ "key": "password", "value": "secrets" }
]
}