Skip to content

Commit b8a74bf

Browse files
deploy: 0080855
1 parent c8d65ca commit b8a74bf

2,047 files changed

Lines changed: 1767 additions & 1693 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

data/documentation/auth0.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Class","modules":[{"name":"Auth0"}],"symbolKind":"class","role":"symbol","externalID":"s:5Auth08ActClaimC","navigatorTitle":[{"text":"ActClaim","kind":"identifier"}],"title":"ActClaim","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"ActClaim","kind":"identifier"}]},"sections":[],"abstract":[{"text":"Represents the ","type":"text"},{"type":"codeVoice","code":"act"},{"type":"text","text":" (actor) claim from an ID token issued during a token exchange delegation flow."}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/init(json:)"],"generated":true,"title":"Initializers","anchor":"Initializers"},{"title":"Instance Properties","anchor":"Instance-Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/act","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/additionalClaims","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/sub"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/tools.ietf.org\/html\/rfc8693#section-4.4","https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/actclaim"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/s8SendableP"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"final","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"ActClaim","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"overview","text":"Overview","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"act","type":"codeVoice"},{"type":"text","text":" claim identifies the acting party — the entity performing actions on behalf of the subject. It is set"},{"text":" ","type":"text"},{"type":"text","text":"server-side via Auth0 Actions using the "},{"type":"codeVoice","code":"api.authentication.setActor()"},{"type":"text","text":" command."}]},{"inlineContent":[{"text":"The claim may be nested to represent delegation chains (e.g., ","type":"text"},{"code":"act.act","type":"codeVoice"},{"type":"text","text":" for multi-hop delegation)."}],"type":"paragraph"},{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"syntax":"swift","type":"codeListing","code":["if let act = credentialsManager.user?.act {"," print(\"Actor: \\(act.sub)\")"," \/\/ Check for delegation chain"," if let innerAct = act.act {"," print(\"Original actor: \\(innerAct.sub)\")"," }","}"]}]}],"references":{"https://tools.ietf.org/html/rfc8693#section-4.4":{"identifier":"https:\/\/tools.ietf.org\/html\/rfc8693#section-4.4","titleInlineContent":[{"text":"RFC 8693: OAuth 2.0 Token Exchange - act Claim","type":"text"}],"title":"RFC 8693: OAuth 2.0 Token Exchange - act Claim","url":"https:\/\/tools.ietf.org\/html\/rfc8693#section-4.4","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/ActClaim/act":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"act","kind":"identifier"},{"kind":"text","text":": "},{"text":"ActClaim","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08ActClaimC"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/actclaim\/act","kind":"symbol","type":"topic","title":"act","abstract":[{"type":"text","text":"A nested "},{"type":"codeVoice","code":"act"},{"text":" claim representing the next actor in a delegation chain.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/act"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","kind":"symbol","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"url":"\/documentation\/auth0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ActClaim/additionalClaims":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/additionalClaims","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"additionalClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"any"},{"text":" ","kind":"text"},{"text":"Sendable","preciseIdentifier":"s:s8SendableP","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"type":"topic","title":"additionalClaims","role":"symbol","url":"\/documentation\/auth0\/actclaim\/additionalclaims","abstract":[{"text":"Any additional claims beyond ","type":"text"},{"type":"codeVoice","code":"sub"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"act"},{"type":"text","text":" (e.g., "},{"code":"org","type":"codeVoice"},{"type":"text","text":", "},{"type":"codeVoice","code":"role"},{"text":").","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ActClaim/init(json:)":{"type":"topic","abstract":[{"type":"text","text":"Creates a new "},{"code":"ActClaim","type":"codeVoice"},{"type":"text","text":" from a JSON dictionary."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/init(json:)","title":"init(json:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"json"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"url":"\/documentation\/auth0\/actclaim\/init(json:)"},"doc://com.auth0.Auth0/documentation/Auth0/ActClaim":{"role":"symbol","url":"\/documentation\/auth0\/actclaim","kind":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ActClaim"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim","abstract":[{"text":"Represents the ","type":"text"},{"type":"codeVoice","code":"act"},{"type":"text","text":" (actor) claim from an ID token issued during a token exchange delegation flow."}],"navigatorTitle":[{"text":"ActClaim","kind":"identifier"}],"title":"ActClaim","type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"https://auth0.com/docs/authenticate/custom-token-exchange":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","titleInlineContent":[{"text":"Custom Token Exchange Documentation","type":"text"}],"title":"Custom Token Exchange Documentation","url":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/ActClaim/sub":{"abstract":[{"type":"text","text":"The subject identifier of the acting party."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sub","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","url":"\/documentation\/auth0\/actclaim\/sub","title":"sub","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/sub"}}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"A nested "},{"code":"act","type":"codeVoice"},{"type":"text","text":" claim representing the next actor in a delegation chain."}],"variants":[{"paths":["\/documentation\/auth0\/actclaim\/act"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim"]]},"metadata":{"externalID":"s:5Auth08ActClaimC3actACSgvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"act","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth08ActClaimC","text":"ActClaim","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","title":"act","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"act","kind":"identifier"},{"text":": ","kind":"text"},{"text":"ActClaim","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim","preciseIdentifier":"s:5Auth08ActClaimC","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/act","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","kind":"symbol","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"url":"\/documentation\/auth0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ActClaim":{"role":"symbol","url":"\/documentation\/auth0\/actclaim","kind":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ActClaim"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim","abstract":[{"text":"Represents the ","type":"text"},{"type":"codeVoice","code":"act"},{"type":"text","text":" (actor) claim from an ID token issued during a token exchange delegation flow."}],"navigatorTitle":[{"text":"ActClaim","kind":"identifier"}],"title":"ActClaim","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ActClaim/act":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"act","kind":"identifier"},{"kind":"text","text":": "},{"text":"ActClaim","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08ActClaimC"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/actclaim\/act","kind":"symbol","type":"topic","title":"act","abstract":[{"type":"text","text":"A nested "},{"type":"codeVoice","code":"act"},{"text":" claim representing the next actor in a delegation chain.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/act"}}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/additionalClaims","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"symbolKind":"property","title":"additionalClaims","role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth08ActClaimC16additionalClaimsSDySSs8Sendable_pGvp","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"additionalClaims"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"any","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Sendable","kind":"typeIdentifier","preciseIdentifier":"s:s8SendableP"},{"text":"]","kind":"text"}],"modules":[{"name":"Auth0"}]},"sections":[],"abstract":[{"type":"text","text":"Any additional claims beyond "},{"type":"codeVoice","code":"sub"},{"text":" and ","type":"text"},{"code":"act","type":"codeVoice"},{"type":"text","text":" (e.g., "},{"code":"org","type":"codeVoice"},{"text":", ","type":"text"},{"type":"codeVoice","code":"role"},{"text":").","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"additionalClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"any","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Sendable","kind":"typeIdentifier","preciseIdentifier":"s:s8SendableP"},{"text":"]","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"inlineContent":[{"text":"Values are preserved as-is, including non-string JSON values (numbers, booleans, objects, arrays), so that","type":"text"},{"type":"text","text":" "},{"text":"custom claims set via ","type":"text"},{"code":"api.authentication.setActor()","type":"codeVoice"},{"type":"text","text":" are not lost."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/actclaim\/additionalclaims"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ActClaim":{"role":"symbol","url":"\/documentation\/auth0\/actclaim","kind":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ActClaim"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim","abstract":[{"text":"Represents the ","type":"text"},{"type":"codeVoice","code":"act"},{"type":"text","text":" (actor) claim from an ID token issued during a token exchange delegation flow."}],"navigatorTitle":[{"text":"ActClaim","kind":"identifier"}],"title":"ActClaim","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","kind":"symbol","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"url":"\/documentation\/auth0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ActClaim/additionalClaims":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/additionalClaims","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"additionalClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"any"},{"text":" ","kind":"text"},{"text":"Sendable","preciseIdentifier":"s:s8SendableP","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"type":"topic","title":"additionalClaims","role":"symbol","url":"\/documentation\/auth0\/actclaim\/additionalclaims","abstract":[{"text":"Any additional claims beyond ","type":"text"},{"type":"codeVoice","code":"sub"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"act"},{"type":"text","text":" (e.g., "},{"code":"org","type":"codeVoice"},{"type":"text","text":", "},{"type":"codeVoice","code":"role"},{"text":").","type":"text"}],"kind":"symbol"}}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"ActClaim"},{"type":"text","text":" from a JSON dictionary."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/init(json:)"},"metadata":{"externalID":"s:5Auth08ActClaimC4jsonACSgSDySSypG_tcfc","title":"init(json:)","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"json"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"roleHeading":"Initializer","symbolKind":"init"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"json"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"json","content":[{"inlineContent":[{"text":"A dictionary representing the ","type":"text"},{"type":"codeVoice","code":"act"},{"text":" claim from a decoded JWT.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/actclaim\/init(json:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim"]]},"sections":[],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ActClaim":{"role":"symbol","url":"\/documentation\/auth0\/actclaim","kind":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ActClaim"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim","abstract":[{"text":"Represents the ","type":"text"},{"type":"codeVoice","code":"act"},{"type":"text","text":" (actor) claim from an ID token issued during a token exchange delegation flow."}],"navigatorTitle":[{"text":"ActClaim","kind":"identifier"}],"title":"ActClaim","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ActClaim/init(json:)":{"type":"topic","abstract":[{"type":"text","text":"Creates a new "},{"code":"ActClaim","type":"codeVoice"},{"type":"text","text":" from a JSON dictionary."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ActClaim\/init(json:)","title":"init(json:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"json"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"url":"\/documentation\/auth0\/actclaim\/init(json:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","kind":"symbol","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"url":"\/documentation\/auth0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","type":"topic"}}}

0 commit comments

Comments
 (0)