summaryrefslogtreecommitdiffstats
path: root/python_openapi_client/fatcat_openapi_client/models/auth_oidc.py
diff options
context:
space:
mode:
Diffstat (limited to 'python_openapi_client/fatcat_openapi_client/models/auth_oidc.py')
-rw-r--r--python_openapi_client/fatcat_openapi_client/models/auth_oidc.py12
1 files changed, 10 insertions, 2 deletions
diff --git a/python_openapi_client/fatcat_openapi_client/models/auth_oidc.py b/python_openapi_client/fatcat_openapi_client/models/auth_oidc.py
index 5d11adab..4fd16901 100644
--- a/python_openapi_client/fatcat_openapi_client/models/auth_oidc.py
+++ b/python_openapi_client/fatcat_openapi_client/models/auth_oidc.py
@@ -3,10 +3,10 @@
"""
fatcat
- A scalable, versioned, API-oriented catalog of bibliographic entities and file metadata # noqa: E501
+ Fatcat is a scalable, versioned, API-oriented catalog of bibliographic entities and file metadata. # noqa: E501
OpenAPI spec version: 0.3.0
-
+ Contact: webservices@archive.org
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
@@ -62,6 +62,7 @@ class AuthOidc(object):
def provider(self):
"""Gets the provider of this AuthOidc. # noqa: E501
+ Fatcat-specific short name (slug) for remote service being used for authentication. # noqa: E501
:return: The provider of this AuthOidc. # noqa: E501
:rtype: str
@@ -72,6 +73,7 @@ class AuthOidc(object):
def provider(self, provider):
"""Sets the provider of this AuthOidc.
+ Fatcat-specific short name (slug) for remote service being used for authentication. # noqa: E501
:param provider: The provider of this AuthOidc. # noqa: E501
:type: str
@@ -85,6 +87,7 @@ class AuthOidc(object):
def sub(self):
"""Gets the sub of this AuthOidc. # noqa: E501
+ `SUB` from OIDC protocol. Usually a URL. # noqa: E501
:return: The sub of this AuthOidc. # noqa: E501
:rtype: str
@@ -95,6 +98,7 @@ class AuthOidc(object):
def sub(self, sub):
"""Sets the sub of this AuthOidc.
+ `SUB` from OIDC protocol. Usually a URL. # noqa: E501
:param sub: The sub of this AuthOidc. # noqa: E501
:type: str
@@ -108,6 +112,7 @@ class AuthOidc(object):
def iss(self):
"""Gets the iss of this AuthOidc. # noqa: E501
+ `ISS` from OIDC protocol. Usually a stable account username, number, or identifier. # noqa: E501
:return: The iss of this AuthOidc. # noqa: E501
:rtype: str
@@ -118,6 +123,7 @@ class AuthOidc(object):
def iss(self, iss):
"""Sets the iss of this AuthOidc.
+ `ISS` from OIDC protocol. Usually a stable account username, number, or identifier. # noqa: E501
:param iss: The iss of this AuthOidc. # noqa: E501
:type: str
@@ -131,6 +137,7 @@ class AuthOidc(object):
def preferred_username(self):
"""Gets the preferred_username of this AuthOidc. # noqa: E501
+ What it sounds like; returned by OIDC, and used as a hint when creating new editor accounts. Fatcat usernames are usually this string with the `provider` slug as a suffix, though some munging may occur. # noqa: E501
:return: The preferred_username of this AuthOidc. # noqa: E501
:rtype: str
@@ -141,6 +148,7 @@ class AuthOidc(object):
def preferred_username(self, preferred_username):
"""Sets the preferred_username of this AuthOidc.
+ What it sounds like; returned by OIDC, and used as a hint when creating new editor accounts. Fatcat usernames are usually this string with the `provider` slug as a suffix, though some munging may occur. # noqa: E501
:param preferred_username: The preferred_username of this AuthOidc. # noqa: E501
:type: str