Add Login Banner

Add Login Banner

Add new login banner. By Default, maximum of 1 login banner can be configured. Only admin users can perform this action.

Request
URI
POST
https://vrni.example.com/api/ni/settings/loginBanner
COPY
Request Body
LoginBannerObject of type(s) application/json
Optional 
{
    "is_enabled": true,
    "login_message_banner": "Please read these terms of Use (the \"Terms\") carefully before using the websites of VMware, Inc. and its subsidiaries (collectively \"VMware\").",
    "user_consent_title": "US Gov Term of Use",
    "user_consent_description": "By accessing, browing or using these websites, you acknowledge that you have read, understood and agree to be bound by these Terms and to comply with all applicable laws and regulations, including United States export and re-export control laws and regulations, diversion contrary to United States export laws is prohibited. If you do not agree to these Terms, you are not authorized to use these websites."
}
boolean
is_enabled
Optional

Boolean flag to indicate login banner is enabled/disabled.

string
login_message_banner
Optional

A summary of this message along with a link to view it in its entirety will be displayed on the login page. It could be maximum 2,000 characters long with a mix of special characters, alphabets, and numbers.

string
user_consent_title
Optional

User consent form title

string
user_consent_description
Optional

User consent form description. Users will have to accept the consent form before proceeding to login. The contents of user consent description will be displayed on the login page. It could be maximum 2,000 characters long with a mix of special characters, alphabets, and numbers.

Authentication
This operation uses the following authentication methods.
Responses
201

Success

Returns LoginBannerObject of type(s) application/json 
{
    "is_enabled": true,
    "login_message_banner": "Please read these terms of Use (the \"Terms\") carefully before using the websites of VMware, Inc. and its subsidiaries (collectively \"VMware\").",
    "user_consent_title": "US Gov Term of Use",
    "user_consent_description": "By accessing, browing or using these websites, you acknowledge that you have read, understood and agree to be bound by these Terms and to comply with all applicable laws and regulations, including United States export and re-export control laws and regulations, diversion contrary to United States export laws is prohibited. If you do not agree to these Terms, you are not authorized to use these websites."
}
boolean
is_enabled
Optional

Boolean flag to indicate login banner is enabled/disabled.

string
login_message_banner
Optional

A summary of this message along with a link to view it in its entirety will be displayed on the login page. It could be maximum 2,000 characters long with a mix of special characters, alphabets, and numbers.

string
user_consent_title
Optional

User consent form title

string
user_consent_description
Optional

User consent form description. Users will have to accept the consent form before proceeding to login. The contents of user consent description will be displayed on the login page. It could be maximum 2,000 characters long with a mix of special characters, alphabets, and numbers.


400

Bad Request

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


403

Forbidden

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


500

Internal Error

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


On This Page
Settings Operations
POST
Activate Serial Number
POST
Add new SNMP Trap destination profile
POST
Add Backup Config
POST
Add Ip Tag
POST
Add Login Banner
POST
Add Restore Config
POST
Add Search Based Alert Config
POST
Add Tag V2
POST
Add Vidm User
POST
Add Vidm User Group
POST
Add Web Proxy
POST
Create Discovery Job
POST
Create Subnet Mapping
POST
Create Subscriber
POST
Create User Defined Event
DELETE
Deactivate Serial Number
DELETE
Delete An existing SNMP Trap destination profile
DELETE
Delete Backup Config
DELETE
Delete Discovery Job
DELETE
Delete Discovery Job Result
DELETE
Delete Job Status
DELETE
Delete Login Banner
DELETE
Delete Restore Config
DELETE
Delete Search Based Alert Config
DELETE
Delete Subnet Mapping
DELETE
Delete Subscriber
DELETE
Delete User
DELETE
Delete User Defined Event
DELETE
Delete User Group
DELETE
Delete Vidm Configuration
DELETE
Delete Web Proxy
POST
Disable Discovery Job
POST
Disable Search Based Alert Config
POST
Disable User Defined Event
POST
Disable Vidm
POST
Enable Discovery Job
POST
Enable Search Based Alert Config
POST
Enable User Defined Event
POST
Enable Vidm
GET
Get details Of An existing SNMP destination profile
GET
Get All Discovery Job Results
GET
Get All Discovery Jobs
GET
Get All Job Status
GET
Get All Search Based Alert Configs
GET
Get All Subscriber
GET
Get All User Defined Events
GET
Get All Users
GET
Get Backup Config
GET
Get Backup Status Report
GET
Get Certificate
GET
Get Connected Clients To Web Proxy
GET
Get Discovery Job
GET
Get Discovery Job Result
GET
Get Infra Nodes Web Proxy
GET
Get Ip Tag
GET
Get Ip Tag Ids
GET
Get Ip Tag V2
GET
Get Job Status
GET
Get Licenses
GET
Get Login Banner
GET
Get Restore Config
GET
Get Restore Status Report
GET
Get Search Based Alert Config
GET
Get Subnet Mappings
GET
Get Subscriber
GET
Get Tag Ids V2
GET
Get User
GET
Get User Defined Event
GET
Get User Group
GET
Get User Groups
GET
Get Users
GET
Get Vidm Configuration
GET
Get Web Proxies
GET
Get Web Proxy
GET
List the configured SNMP Trap destination profiles
POST
Migrate event subscriptions To other SNMP Trap destination profiles
POST
Remove Ip Tag
POST
Remove Tag V2
POST
Save Vidm Configuration
POST
Send Test trap To SNMP destination profile
PUT
Update An existing SNMP destination profile
PUT
Update user password
PUT
Update Backup Config
PUT
Update Discovery Job
PUT
Update Login Banner
PUT
Update Search Based Alert Config
PUT
Update Subnet Mapping
PUT
Update Subscriber
PUT
Update User Defined Event
PUT
Update Vidm Configuration
PUT
Update Vidm User Group Role
PUT
Update Vidm User Role
PUT
Update Web Proxy
POST
Validate Connections Via Web Proxy
POST
Validate Serial Number
POST
Validate Web Proxy Migration