Sha256: efa4649bc3465d44c6a103bb019a37c2cd08e4e57deeae680921f8f70a808a15
Contents?: true
Size: 1.19 KB
Versions: 437
Compression:
Stored size: 1.19 KB
Contents
# Session
## Example Session Object
```
{
"id": "60525f92e859c4c3d74cb02fd176b1525901b525",
"language": "en",
"read_only": true,
"sftp_insecure_ciphers": true
}
```
* `id` (string): Session ID
* `language` (string): Session language
* `read_only` (boolean): Is this session read only?
* `sftp_insecure_ciphers` (boolean): Are insecure SFTP ciphers allowed for this user? (If this is set to true, the site administrator has signaled that it is ok to use less secure SSH ciphers for this user.)
* `username` (string): Username to sign in as
* `password` (string): Password for sign in
* `otp` (string): If this user has a 2FA device, provide its OTP or code here.
* `partial_session_id` (string): Identifier for a partially-completed login
---
## Create user session (log in)
```
Files::Session.create(
username: "username",
password: "password",
otp: "123456"
)
```
### Parameters
* `username` (string): Username to sign in as
* `password` (string): Password for sign in
* `otp` (string): If this user has a 2FA device, provide its OTP or code here.
* `partial_session_id` (string): Identifier for a partially-completed login
---
## Delete user session (log out)
```
Files::Session.delete
```
Version data entries
437 entries across 437 versions & 1 rubygems