Dell N3200-ON Networking N-Series Switches RESTful API User Guide version 6.8. - Page 19

Authentication, Login

Page 19 highlights

Authentication Login Implements a RESTful API providing user authentication and authorization. A user session is required for all RESTful API requests. A user session is established by logging in with a valid username and password. Upon successful login, a session identifier (SID) is returned. Use this SID with all future requests. When you are finished with your session, logout. A successful logout request deletes the SID and invalidates the session. Note that the SID will automatically be deleted if the hard or soft time-out is exceeded. The username, password, and switch access level, as well as the session time-out parameters, are managed by your system administrator. It is recommended that you always use HTTPS to ensure security. Login CREATE POST /open/v1/login Use this call to create a login session. Upon successful login, a user SID (or SIDSSL for HTTPS) is returned. Use this SID for future requests until you are done with the session by logging out. Note that while the login feature provides access control to the switch over HTTP connections, it does not provide security. This is because the SID is sent as cleartext over HTTP. A spoofer listening for packets can determine the SID and issues requests to the switch through the RESTful API using the same SID. For security, HTTPS is a better choice. Request Details Table 4-5. Login CREATE Request Details Parameter username password Type String String Description User name or identifier. User password. Rest API Reference 19

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217

Rest API Reference
19
Authentication
Login
Implements a RESTful API providing user authentication and authorization.
A user session is required for all RESTful API requests. A user session is
established by logging in with a valid username and password. Upon
successful login, a session identifier (SID) is returned. Use this SID with all
future requests. When you are finished with your session, logout. A successful
logout request deletes the SID and invalidates the session. Note that the SID
will automatically be deleted if the hard or soft time-out is exceeded. The
username, password, and switch access level, as well as the session time-out
parameters, are managed by your system administrator.
It is recommended that you always use HTTPS to ensure security.
Login CREATE
POST /open/v1/login
Use this call to create a login session.
Upon successful login, a user SID (or SIDSSL for HTTPS) is returned. Use
this SID for future requests until you are done with the session by logging
out. Note that while the login feature provides access control to the switch
over HTTP connections, it does not provide security. This is because the SID
is sent as cleartext over HTTP. A spoofer listening for packets can determine
the SID and issues requests to the switch through the RESTful API using the
same SID. For security, HTTPS is a better choice.
Request Details
Table 4
-
5.
Login CREATE Request Details
Parameter
Type
Description
username
String
User name or identifier.
password
String
User password.