Skip to content

Commit 5850910

Browse files
Updated the info() return values (#189)
* Updated the info() return values * Acted on reviewer s comment * Removed reference of unified_login_flow_enabled in the sample return array
1 parent ba05854 commit 5850910

1 file changed

Lines changed: 20 additions & 3 deletions

File tree

shotgun_api3/shotgun.py

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -693,12 +693,29 @@ def info(self):
693693
Get API-related metadata from the Shotgun server.
694694
695695
>>> sg.info()
696-
{'full_version': [6, 3, 15, 0], 'version': [6, 3, 15], ...}
696+
{'full_version': [8, 2, 1, 0], 'version': [8, 2, 1], 'user_authentication_method': 'default', ...}
697+
698+
Tokens and values
699+
-----------------
700+
701+
::
702+
703+
Token Value
704+
-------- ---------
705+
full_version An ordered array of the full Shotgun version.
706+
[major, minor, patch, hotfix]
707+
version An ordered array of the Shotgun version.
708+
[major, minor, patch]
709+
user_authentication_method Indicates the authentication method used by Shotgun.
710+
Will be one of the following values:
711+
default: regular username/password.
712+
ldap: username/password from the company's LDAP.
713+
saml2: SSO used, over SAML2.
697714
698715
.. note::
699716
700-
Beyond ``full_version`` and ``version`` which differ by the inclusion of the bugfix number, you should expect
701-
these values to be unsupported and for internal use only.
717+
Beyond the documented tokens, you should expect
718+
the other values to be unsupported and for internal use only.
702719
703720
:returns: dict of the server metadata.
704721
:rtype: dict

0 commit comments

Comments
 (0)