vapi metadata authentication: package info
package_info
structure contains authentication information of a package element. For an explanation of authentication information contained within package elements, see vapi.metadata.authentication.package.
Representation:
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
-.schemes | authentication_info[] | List of authentication schemes to be used for all the operation elements contained in this package element. If a particular service or operation element has no explicit authentications defined in the authentication defintion file, these authentication schemes are used for authenticating the user.
|
-.schemes[].scheme_type | string | The type of the authentication scheme. Provides enumeration values for the set of valid authentication scheme types. Value is one of: |
-.schemes[].scheme | string | String identifier of the authentication scheme. Following are the supported authentication schemes by the infrastructure:
|
-.services | object | Information about all service elements contained in this package element that contain authentication information. The key in the key/value pairs is the identifier of the service element and the value in the key/value pairs is the authentication information for the service element. For an explanation of authentication information containment within service elements, see vapi.metadata.authentication.service. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
-.services.* | service_info | |
-.services.*.schemes | authentication_info[] | List of authentication schemes to be used for all the operation elements contained in this service element. The authentication scheme specified on the package element corresponding to this service element is ignored.
|
-.services.*.schemes[].scheme_type | string | The type of the authentication scheme. Provides enumeration values for the set of valid authentication scheme types. Value is one of: |
-.services.*.schemes[].scheme | string | String identifier of the authentication scheme. Following are the supported authentication schemes by the infrastructure:
|
-.services.*.operations | object | Information about all operation elements contained in this service element that contain authentication information. The key in the key/value pairs is the identifier of the operation element and the value in the key/value pairs is the authentication information for the operation element. For an explanation of containment of authentication information within operation elements, see vapi.metadata.authentication.service.operation. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
-.services.*.operations.* | operation_info | |
-.services.*.operations.*.schemes | authentication_info[] | List of authentication schemes used by an operation element. The authentication scheme specified on the service element corresponding to this operation element is ignored.
|
-.services.*.operations.*.schemes[].scheme_type | string | The type of the authentication scheme. Provides enumeration values for the set of valid authentication scheme types. Value is one of: |
-.services.*.operations.*.schemes[].scheme | string | String identifier of the authentication scheme. Following are the supported authentication schemes by the infrastructure:
|
Optional | ||
-.schemes[].session_manager | string | In a session aware authentication scheme, a session manager is required that supports create , delete and keepAlive operations. The fully qualified service name of the session manager is provided in vapi.metadata.authentication.authentication_info.session_manager field. This service is responsible for handling sessions. Optional. It is only relevant when scheme_type has value SESSION_AWARE. This field is optional and it is only relevant when the value of |
-.services.*.schemes[].session_manager | string | In a session aware authentication scheme, a session manager is required that supports create , delete and keepAlive operations. The fully qualified service name of the session manager is provided in vapi.metadata.authentication.authentication_info.session_manager field. This service is responsible for handling sessions. Optional. It is only relevant when scheme_type has value SESSION_AWARE. This field is optional and it is only relevant when the value of |
-.services.*.operations.*.schemes[].session_manager | string | In a session aware authentication scheme, a session manager is required that supports create , delete and keepAlive operations. The fully qualified service name of the session manager is provided in vapi.metadata.authentication.authentication_info.session_manager field. This service is responsible for handling sessions. Optional. It is only relevant when scheme_type has value SESSION_AWARE. This field is optional and it is only relevant when the value of |
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
schemes | authentication_info[] | List of authentication schemes to be used for all the operation elements contained in this package element. If a particular service or operation element has no explicit authentications defined in the authentication defintion file, these authentication schemes are used for authenticating the user.
|
schemes[].scheme_type | string | The type of the authentication scheme. Provides enumeration values for the set of valid authentication scheme types. Value is one of: |
schemes[].scheme | string | String identifier of the authentication scheme. Following are the supported authentication schemes by the infrastructure:
|
services | list | Information about all service elements contained in this package element that contain authentication information. The key in the key/value pairs is the identifier of the service element and the value in the key/value pairs is the authentication information for the service element. For an explanation of authentication information containment within service elements, see vapi.metadata.authentication.service. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
services[].key | string | |
services[].value | service_info | |
services[].value.schemes | authentication_info[] | List of authentication schemes to be used for all the operation elements contained in this service element. The authentication scheme specified on the package element corresponding to this service element is ignored.
|
services[].value.schemes[].scheme_type | string | The type of the authentication scheme. Provides enumeration values for the set of valid authentication scheme types. Value is one of: |
services[].value.schemes[].scheme | string | String identifier of the authentication scheme. Following are the supported authentication schemes by the infrastructure:
|
services[].value.operations | list | Information about all operation elements contained in this service element that contain authentication information. The key in the key/value pairs is the identifier of the operation element and the value in the key/value pairs is the authentication information for the operation element. For an explanation of containment of authentication information within operation elements, see vapi.metadata.authentication.service.operation. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
services[].value.operations[].key | string | |
services[].value.operations[].value | operation_info | |
services[].value.operations[].value.schemes | authentication_info[] | List of authentication schemes used by an operation element. The authentication scheme specified on the service element corresponding to this operation element is ignored.
|
services[].value.operations[].value.schemes[].scheme_type | string | The type of the authentication scheme. Provides enumeration values for the set of valid authentication scheme types. Value is one of: |
services[].value.operations[].value.schemes[].scheme | string | String identifier of the authentication scheme. Following are the supported authentication schemes by the infrastructure:
|
Optional | ||
schemes[].session_manager | string | In a session aware authentication scheme, a session manager is required that supports create , delete and keepAlive operations. The fully qualified service name of the session manager is provided in vapi.metadata.authentication.authentication_info.session_manager field. This service is responsible for handling sessions. Optional. It is only relevant when scheme_type has value SESSION_AWARE. This field is optional and it is only relevant when the value of |
services[].value.schemes[].session_manager | string | In a session aware authentication scheme, a session manager is required that supports create , delete and keepAlive operations. The fully qualified service name of the session manager is provided in vapi.metadata.authentication.authentication_info.session_manager field. This service is responsible for handling sessions. Optional. It is only relevant when scheme_type has value SESSION_AWARE. This field is optional and it is only relevant when the value of |
services[].value.operations[].value.schemes[].session_manager | string | In a session aware authentication scheme, a session manager is required that supports create , delete and keepAlive operations. The fully qualified service name of the session manager is provided in vapi.metadata.authentication.authentication_info.session_manager field. This service is responsible for handling sessions. Optional. It is only relevant when scheme_type has value SESSION_AWARE. This field is optional and it is only relevant when the value of |