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

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