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

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