POST /api/users/ndbid/{userNdbid}/aura/optin

Opts in for Aura digital calling. User nbid can be retrieved from users/users_me response

Header

NameDescriptionData TypeRequiredDefault Value
AuthorizationJwt/OAuth2 bearer tokenStringYes

Body Parameters

NameDescriptionData typeRequiredDefault Value
userAuraSystemIdUser Aura system IDstringYes
userEmailUser's emailstringYes

Authentication

JwtAuthenticator, Oauth2Authenticator

Example Request

URL

For Production: POST https://spacesapis.avayacloud.com/api/users/ndbid/{userNdbid}/aura/optin
For Staging: POST https://loganstagingapis.esna.com/api/users/ndbid/{userNdbid}/aura/optin

Headers

Authorization: "jwt eyJhbGciOiJSUzl1NiIsIdfgdfgnR5cCI6IkpXVCJ9.eyJ1c2VyX3lkX3NpZyI6ImxPWHpxNzVzR3J3X0xwWEMyRGRMakhyYXJlWVhyTzFMdEZHZkhkOWNkTXciLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAxNy0wMS0zMFQxMzo1ODo0Ny4yMDYiLCJpc3MiOiJ6YW5nLmlvIiwicHVibGlja2V5aWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUdnc1NEVWRLZDNSUWRXSnNhV05MWlhrdfgdWdJQ2dsUEtFakFvTSIsImV4cCI6MTQ5NTM5MTIwMywidXNlcl9pZCI6ImFneHpmbTl1WlhOdVlUSXdNVFJ5RVFzU0JGVnpaWElZZ0lEQXMtX25fUW9NIiwidmVyIjoiMi4wIn0.SqZpw1uPIebqW3qlDsm0-DWYFKEH0SgPwtD-tSESWOF-5hLkZMqJH28ooWux2S7s9riIew7pTVPnZpTgJa5zHcEAG0gXSEJVOqmpGp_4ufM8YtZoZMpBFjyAkwyAt-ILkGUYIo0GU5WyzMPLV8YLXfgdfgOgkE2MGGOajBkjPmC2Db3pA0D0M9k-21EL1gwWBC5YIq0PDAkgulegwl6khRmB8irJQ-dfg-d-KV9eYfFpsCdJKRGzSfqg"

Or

Authorization: "bearer f746696f5de4528u128ae2f274eea253e8a7943a"

Body

{
   "userAuraSystemId":"615b90e7e8de49bc24d61481",
   "userEmail":"testuser123@avaya.com"
}

Example code snippet:

curl --location --request POST 'https://spacesapis.avayacloud.com/api/users/ndbid/ag9zfm9uZXNuYXRlc3RpbmdyEQsSBFVzZXIYgICAsP6knQoM/aura/optin' --header 'authorization: jwt eyJhbGciOiJLUzI1NiISInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkX3NpZyI6Im5YeGFKUW0wblZJWnVPXzgwQ3VMZmxJeUd3RXNaS3h6dF9Mbk9sZnphR00iLCJwcm9kdWN0X3R5cGUiOiJhY2NvdW50cyIsImxhc3R1cGRhdGV0aW1lIjoiMjAyMS0wOC0zMFQxMjoyMTowNy43MzIiLCJpc3MiOiJhdmF5YWNsb3VkLmNvbSIsInB1YmxpY2tleWlkIjoiYWd4emZtOXVaWE51WVRJd01UUnlHZ3NTRFVkS2QzUlFkV0pzYVdOTFpYa1lnSUR3ODhhRHBRZ00iLCJleHAiOjE2NDQ3NTAwMDksInVzZXJfaWQiOiJhZ3h6Zm05dVpYTnVZVEl3TVRSeUVRc1NCRlZ6WlhJWWdJRFF1Wl9zMVFzTSIsInZlciI6IjIuMCJ9.fjiTatv-fG6iyeB96j8dKPoDCs6ASHVrIvTTqFZL_IPe2Vl3E_SBJk9-71pbcr4JkGxzq6Tg0iBW3CBlOVnPkIQXIIOnCau0toRaBWxVUUzR5bnJtHZyNZHJ9hy_3AYz7OXHo61_np5xCNjUDYy-RrI87eXoiNrnOSPHzMfa-o193pkFknXfcBQjIxiYZgjZNnSCZfAf2H_pk8RawipS-r8LNyYkGoiU9XMKonUSgD4vR18tVzaU__qyjjwTs9E9UYcXvLZw6PT0VvJcJerPn5VVgzAPGc8thYMrSSVpy3n-_eJ33j8cBEAT5R1jALSrdTKV_6Ujvi7s-IvW_YM3zg'

Example Response

 {
    "id":"agxzfm9uZXNuYTIwMTRyEQsSsFVzZXIYgIDQuZ_s1QsM",
    "name":{
       "familyname":"User123",
       "formatted":"",
       "givenname":"Test",
       "honorific_prefix":"",
       "honorific_suffix":"",
       "middlename":"",
       "pronunciation":"",
       "pronunciation_url":""
    },
    "spaceCalling":{
       "sipAddresses":{
          "identities":[
            
          ]
       },
       "auraSystemId":"615b90e7e8de49bc24d61481",
       "auraSystemName":"AAWG-Alpha-Blue",
       "optInStatus":"opt-in-pending",
       "auraSystemConnectionStatus":"CONNECTED"
    },
    "displayname":"Test User123",
    "emails":[
       {
          "value":"testuser123@avaya.com",
          "type":"",
          "primary":true,
          "label":"",
          "relationdef_id":"agxzfm9uZmNuYTIwMTRyGAsSC1JlbGF0aW9uRGVmGICA0Pmf4cMKDA"
       }
    ],
    "username":"testuser123@avaya.com",
    "picture_url":"https:storage.googleapis.com/onesna/pictures/pfpic_testuser123_34cb97bd-0151-449d-84b0-48e07853b49f",
    "isAuraFeatureEnabled":true
 }