show security settings

GET /show
show security settings
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/security/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json
  • web_login

    object

    Placeholder
    Show child attributes
  • sip

    object

    Show child attributes

Sample Response

                      
{}
                      
                    

Create disallowed codes

POST /disallowed_codes/create
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • description

    string

    required

    Placeholder
  • number_prefix

    string

    required

    Placeholder

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/security/disallowed_codes/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Created disallowed codes
application/json
  • id

    integer

    format : int64

Sample Response

                      
{}
                      
                    

Update allowed country codes

POST /allowed_country_codes/update
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • codes

    array

    required

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/security/allowed_country_codes/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Updated allowed country codes

Sample Response

                      
                      
                    

List allowed country codes

GET /allowed_country_codes/list
List allowed country codes
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/security/allowed_country_codes/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json

Sample Response

                      
{}
                      
                    

Destroy disallowed codes

POST /disallowed_codes/destroy
Destroy disallowed codes
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • id

    integer

    required

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/security/disallowed_codes/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Successful operation
404
User not found
400
Invalid entry ID supplied

Sample Response

                      
                      
                    

Update security settings

POST /update
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • web_login

    object

    required

    Placeholder
    Show child attributes
  • sip

    object

    required

    Show child attributes

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/security/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'
                      
                    

Responses

200
Update security settings

Sample Response

                      
                      
                    

List disallowed codes

GET /disallowed_codes/list
List disallowed codes
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • pagination

    integer

    optional

    The pagination of paging.

    format : int32

  • pagesize

    integer

    required

    The size of paging.
  • sort_by

    string

    optional

    Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.

    enum : ['DEFAULT', 'OPTIONAL']

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/security/disallowed_codes/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                      
                    

Responses

200
Successful operation
application/json
  • sort_by

    string

  • pagesize

    integer

  • codes

    array

    Show child attributes
  • pagination

    integer

  • count

    integer

Sample Response

                      
{
    "sort_by": "DEFAULT",
    "pagesize": 10,
    "pagination": 8,
    "count": 100
}