Skip to the content.

๐Ÿ” Authentication

AWS

Parameters


Optional


Template


AWS (type : SRP)

{
    "users": {
        "user1": {
            "auth": "schema1",
            "username": "**string**",
            "password": "**string**",
            "refresh_token": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "aws",
            "type": "SRP",
            "region": "**string**",
            "location": "**string**",
            "client_id": "**string**",
            "pool_id": "**string**",
            "options": {
                "client_secret": "**string**",
                "header_name": "**string**",
                "header_key": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

AWS (type : Password Authentication)

{
    "users": {
        "user1": {
            "auth": "schema1",
            "username": "**string**",
            "password": "**string**",
            "refresh_token": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "aws",
            "type": "Password Authentication",
            "region": "**string**",
            "location": "**string**",
            "client_id": "**string**",
            "options": {
                "client_secret": "**string**",
                "header_name": "**string**",
                "header_key": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

AWS (type : AWS Signature)

{
    "users": {
        "user1": {
            "auth": "schema1",
            "username": "**string**",
            "password": "**string**",
            "refresh_token": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "aws",
            "type": "AWS Signature",
            "region": "**string**",
            "location": "**string**",
            "client_id": "**string**",
            "options": {
                "client_secret": "**string**",
                "header_name": "**string**",
                "header_key": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

AWS (type : Refresh Token)

{
    "users": {
        "user1": {
            "auth": "schema1",
            "username": "**string**",
            "password": "**string**",
            "refresh_token": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "aws",
            "type": "Refresh Token",
            "region": "**string**",
            "location": "**string**",
            "service_name": "**string**",
            "method": "**string**",
            "hash_algorithim": "**string**",
            "options": {
                "client_secret": "**string**",
                "header_name": "**string**",
                "header_key": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

REST

Parameters


Optional


Template


REST

{
    "users": {
        "user1": {
            "auth": "schema1",
            "**username**": "**admin**",
            "**password**": "**1234**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "rest",
            "url": "**string**",
            "method": "**string**",
            "options": {
                "token_name": "**string**",
                "refresh_url": "**string**",
                "refresh_token_name": "**string**",
                "header_name": "**string**",
                "header_key": "**string**",
                "cookie_auth": "**boolean**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

Digest

Parameters


Optional


Template


Digest

{
    "users": {
        "user1": {
            "auth": "schema1",
            "username": "**string**",
            "password": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "digest",
            "url": "**string**",
            "method": "**string**",
            "options": {
                "realm": "**string**",
                "nonce": "**string**",
                "algorithm": "**string**",
                "qop": "**string**",
                "nonce_count": "**string**",
                "client_nonce": "**string**",
                "opaque": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

GraphQL

Parameters


Optional


Template


GraphQL

{
    "users": {
        "user1": {
            "auth": "schema1",
            "**username**": "**admin**",
            "**password**": "**1234**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "graphql",
            "url": "**string**",
            "mutation_name": "**string**",
            "mutation_field": "**string**",
            "method": "**string**",
            "options": {
                "refresh_mutation_name": "**string**",
                "refresh_field": "**boolean**",
                "refresh_field_name": "**string**",
                "header_name": "**string**",
                "operation": "**string**",
                "header_key": "**string**",
                "cookie_auth": "**boolean**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

Manual

Parameters


Template


Manual

{
    "users": {
        "user1": {
            "auth": "schema1",
            "headers": {
                "**name**": "**value**"
            }
        }
    },
    "auth": {
        "schema1": {
            "tech": "manual"
        }
    }
}

Basic

Parameters


Optional


Template


Basic

{
    "users": {
        "user1": {
            "auth": "schema1",
            "username": "**string**",
            "password": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "basic",
            "options": {
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

API

Parameters


Optional


Template


API

{
    "users": {
        "user1": {
            "auth": "schema1",
            "api_key": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "api_key",
            "location": "**string**",
            "header_name": "**string**",
            "options": {
                "header_prefix": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

No authentification

Parameters


Template


No authentification

{
    "users": {
        "no_auth": {
            "auth": "schema1"
        }
    },
    "auth": {
        "schema1": {
            "tech": "noauth"
        }
    }
}

OAuth

Parameters


Optional


Template


OAuth (grant_type : auth_code)

{
    "users": {
        "user1": {
            "auth": "schema1",
            "client_id": "**string**",
            "client_secret": "**string**",
            "refresh_token": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "oauth",
            "grant_type": "auth_code",
            "auth_location": "**enum**",
            "header_prefix": "**string**",
            "location": "**enum**",
            "scope": "**string**",
            "authentication_endpoint": "**string**",
            "token_endpoint": "**string**",
            "callback_url": "**string**",
            "options": {
                "state": "**string**",
                "code_verifier": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

OAuth (grant_type : implicit)

{
    "users": {
        "user1": {
            "auth": "schema1",
            "client_id": "**string**",
            "client_secret": "**string**",
            "refresh_token": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "oauth",
            "grant_type": "implicit",
            "auth_location": "**enum**",
            "header_prefix": "**string**",
            "location": "**enum**",
            "scope": "**string**",
            "authentication_endpoint": "**string**",
            "callback_url": "**string**",
            "options": {
                "state": "**string**",
                "code_verifier": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

OAuth (grant_type : client_cred)

{
    "users": {
        "user1": {
            "auth": "schema1",
            "client_id": "**string**",
            "client_secret": "**string**",
            "refresh_token": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "oauth",
            "grant_type": "client_cred",
            "auth_location": "**enum**",
            "header_prefix": "**string**",
            "location": "**enum**",
            "scope": "**string**",
            "token_endpoint": "**string**",
            "options": {
                "state": "**string**",
                "code_verifier": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}

OAuth (grant_type : password_cred)

{
    "users": {
        "user1": {
            "auth": "schema1",
            "client_id": "**string**",
            "client_secret": "**string**",
            "refresh_token": "**string**"
        }
    },
    "auth": {
        "schema1": {
            "tech": "oauth",
            "grant_type": "password_cred",
            "auth_location": "**enum**",
            "header_prefix": "**string**",
            "location": "**enum**",
            "scope": "**string**",
            "token_endpoint": "**string**",
            "options": {
                "state": "**string**",
                "code_verifier": "**string**",
                "headers": {
                    "**name**": "**value**"
                }
            }
        }
    }
}