API Reference
doky.AuthSession
Creates an object to manage the authentication session.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session_id |
str
|
Your session ID from labs.play-with-docker.com |
required |
Source code in doky/auth_session.py
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 |
|
get_me()
Bound method that requests for current user session informations.
Returns:
Type | Description |
---|---|
dict
|
Current user session informations. |
Return Example
{
'id': 'XXXXXX',
'name': 'd3cryptofc',
'provider_user_id': '1000XXX',
'avatar': 'https://avatars.io/twitter/d3cryptofc',
'provider': 'docker',
'email': 'd3cryptofc@gmail.com',
'banned': False
}
Raises:
Type | Description |
---|---|
HTTPStatusError
|
Bad response HTTP status code. |
Source code in doky/auth_session.py
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 |
|
get_providers()
staticmethod
Static method that requests for a list of available providers.
Returns:
Type | Description |
---|---|
List[str]
|
List of available providers. |
Return Example
['docker']
Raises:
Type | Description |
---|---|
HTTPStatusError
|
Bad response HTTP status code. |
Source code in doky/auth_session.py
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 |
|
request_oauth_url(provider='docker')
staticmethod
Static method that requests an OAuth URL to a provider.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
provider |
str
|
The OAuth available provider. |
'docker'
|
Returns:
Type | Description |
---|---|
str
|
The OAuth URL for authentication. |
Return Example
https://login.docker.com/authorize/?client_id=XXXXXX&nonce=XXXXXX&redirect_uri=XXXXXX&response_type=code&scope=XXXXXX&state=XXXXXX
Raises:
Type | Description |
---|---|
RuntimeError
|
Some unexpected error. |
Source code in doky/auth_session.py
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 |
|