summaryrefslogtreecommitdiffstats
path: root/fatcat-openapi/docs/AuthOidc.md
diff options
context:
space:
mode:
Diffstat (limited to 'fatcat-openapi/docs/AuthOidc.md')
-rw-r--r--fatcat-openapi/docs/AuthOidc.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/fatcat-openapi/docs/AuthOidc.md b/fatcat-openapi/docs/AuthOidc.md
new file mode 100644
index 0000000..de80baa
--- /dev/null
+++ b/fatcat-openapi/docs/AuthOidc.md
@@ -0,0 +1,13 @@
+# AuthOidc
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **String** | Fatcat-specific short name (slug) for remote service being used for authentication. |
+**sub** | **String** | `SUB` from OIDC protocol. Usually a URL. |
+**iss** | **String** | `ISS` from OIDC protocol. Usually a stable account username, number, or identifier. |
+**preferred_username** | **String** | 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. |
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+