discogs-service/docs/data/documentation/discogsservice/authmethod.json

{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"sections":[],"abstract":[{"type":"text","text":"A representation of the available authentication methods at the Discogs service."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/authmethod"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthMethod"}],"modules":[{"name":"DiscogsService"}],"role":"symbol","symbolKind":"enum","navigatorTitle":[{"kind":"identifier","text":"AuthMethod"}],"roleHeading":"Enumeration","title":"AuthMethod","externalID":"s:14DiscogsService10AuthMethodO"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMethod","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","anchor":"overview","text":"Overview"},{"inlineContent":[{"type":"text","text":"The differences between these authentication methods."}],"type":"paragraph"},{"header":"row","alignments":["unset","center","center","center"],"type":"table","rows":[[[{"inlineContent":[{"type":"text","text":"Credentials in request"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"Rate limiting?"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"Image URLs?"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"Authenticated as user?"}],"type":"paragraph"}]],[[{"inlineContent":[{"type":"text","text":"None"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"🐢 Low tier"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"❌ No"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"❌ No"}],"type":"paragraph"}]],[[{"inlineContent":[{"type":"text","text":"Only Consumer key\/secret"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"🐰 High tier"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"✔️ Yes"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"❌ No"}],"type":"paragraph"}]],[[{"inlineContent":[{"type":"text","text":"Personal access token"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"🐰 High tier"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"✔️ Yes"}],"type":"paragraph"}],[{"inlineContent":[{"type":"text","text":"✔️ Yes, for token holder only 👩"}],"type":"paragraph"}]]]},{"inlineContent":[{"type":"text","text":"Please refer to the "},{"identifier":"https:\/\/www.discogs.com\/developers#page:authentication,header:authentication-discogs-auth-flow","type":"reference","isActive":true},{"type":"text","text":" for further details."}],"type":"paragraph"}],"kind":"content"}],"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/consumer(key:secret:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/none","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/user(token:)"],"generated":true,"anchor":"Enumeration-Cases"},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/Equatable-Implementations"],"anchor":"Default-Implementations","generated":true}],"seeAlsoSections":[{"title":"Authentication","generated":true,"anchor":"Authentication","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport"]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod"},"references":{"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/consumer(key:secret:)":{"abstract":[{"text":"A consumer key and secret that allows access to endpoints that requires authentication.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"consumer"},{"kind":"text","text":"("},{"kind":"externalParam","text":"key"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"secret"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"type":"topic","url":"\/documentation\/discogsservice\/authmethod\/consumer(key:secret:)","role":"symbol","title":"AuthMethod.consumer(key:secret:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/consumer(key:secret:)"},"doc://DiscogsService/documentation/DiscogsService/AuthTransport":{"abstract":[{"text":"A representation of the available transport options to send credentials in authenticated requests.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"AuthTransport","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthTransport","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/authtransport","title":"AuthTransport"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod":{"abstract":[{"type":"text","text":"A representation of the available authentication methods at the Discogs service."}],"role":"symbol","navigatorTitle":[{"text":"AuthMethod","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMethod","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/authmethod","title":"AuthMethod"},"doc://DiscogsService/documentation/DiscogsService/AuthMiddleware":{"abstract":[{"text":"A middleware that attaches any defined authentication credentials into the requests to the service.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthMiddleware"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/authmiddleware","title":"AuthMiddleware"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/none":{"kind":"symbol","title":"AuthMethod.none","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"none","kind":"identifier"}],"url":"\/documentation\/discogsservice\/authmethod\/none","abstract":[{"text":"No authentication method defined.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/none","role":"symbol"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/user(token:)":{"abstract":[{"text":"A user token that allows access to its own account information.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"type":"topic","url":"\/documentation\/discogsservice\/authmethod\/user(token:)","role":"symbol","title":"AuthMethod.user(token:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/user(token:)"},"doc://DiscogsService/documentation/DiscogsService/AuthMethod/Equatable-Implementations":{"abstract":[],"kind":"article","type":"topic","url":"\/documentation\/discogsservice\/authmethod\/equatable-implementations","role":"collectionGroup","title":"Equatable Implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod\/Equatable-Implementations"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"https://www.discogs.com/developers#page:authentication,header:authentication-discogs-auth-flow":{"type":"link","identifier":"https:\/\/www.discogs.com\/developers#page:authentication,header:authentication-discogs-auth-flow","title":"Discogs documentation","url":"https:\/\/www.discogs.com\/developers#page:authentication,header:authentication-discogs-auth-flow","titleInlineContent":[{"text":"Discogs documentation","type":"text"}]}}}