Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/siplocalauthtable/{identifier}/siplocalauthentry/{identifier}

Page Tree
rootResource - siplocalauthentry

Modifies a SIP Local Passthrough Authorization Table Entry given a specific Table Entry ID in a given SIP Local Passthrough Authorization Table.

URL:

https://

...

192.

...

168.

...

0.

...

111/rest/siplocalauthtable/{identifier}/siplocalauthentry/{identifier}

HTTP Method

POST

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[siplocalauthentry - REST API Methods|Resource - siplocalauthentry]

Page Tree
root@parent

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
AorTypeYesYesEnum1Possible values:
  • 0 - e_HostNone
  • 1 - e_HostLocal
  • 2 - e_HostRemote
  • 3 - e_HostStatic
Specifies how the Address of Record (AOR) is received from a SIP endpoint
  • Local
    - the contact registrant is the

...

  • SBC

...

  • Remote
    - the contact registrant is a separate SIP Server/Proxy host
AORYesYesstringnone512 - Max Length Identifies the address of record for this client to be registered to the SIP server. If Type of Address of Record is set to Remote, the URI must contain protocol:user@host, for example: sip:17324609000@remoterserver.com. When

...

the

...

SBC

...

receives a SIP request, this authorization table is searched for a match and uses the realm/user/password to challenge the request.
UserYesNostringnone64 - Max LengthSpecifies the user name used by the proxy to challenge a request message.
EncryptedPasswordYesNostringnone64 - Max LengthEncrypted password used along with the user name to calculate digest authentication.

Tip
titleHelpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

...

Usage Example: (about cURL | requires a session token)

Code Block
languagebash
Put code example here

Response:

...

languagehtml/xml

...