643 matches
Other/PhantAuth
This endpoint allows you to get the data of a given PhantAuth tenant. To use the PhantAuth services, you don't need this endpoint. It is, therefore, mainly used for debug/diagnostic purposes in tenant customization.
Tenantname is the name of the full DNS domain of the tenant you get. In the case of an official and shared tenant (phantauth.net and phantauth.cf DNS domains), the DNS domain can be omitted (e.g. default or faker).
{
"type": "object",
"properties": {
"tenantname": {
"type": "string"
}
},
"required": [
"tenantname"
],
"additionalProperties": false
}{
"type": "object",
"required": [
"issuer",
"sub"
],
"properties": {
"@id": {
"type": "string",
"description": "The URL of the tenant's JSON representation."
},
"about": {
"type": "string",
"description": "A detailed description of the tenant. If it takes the value of an URL, the description is downloaded from the given URL, otherwise the value it takes is the description itself. Markdown formatting can be used in the description."
},
"attribution": {
"type": "string",
"description": "The attribution of the external data source or random user generator. Its value can have markdown formatting, that is, the external source can contain highlights and links."
},
"depot": {
"type": "string",
"description": "It defines the place of the CSV file containing the resource data in [RFC 6570 - URI temaplate](https://tools.ietf.org/html/rfc6570) format.\nThe URI template receives the type of the object to be generated (user, team) in the `kind` parameter.\n\nThe first line of the CSV file contains the resource property names, the following lines, on the other hand, contain the relevant data.\nIn the case of nested properties, a '.' character separates the elements of the property name (e.g. address.formatted)."
},
"depots": {
"type": "array",
"description": "A list of resource types supported by the external CSV set in `depot`.",
"items": {
"type": "object"
}
},
"domain": {
"type": "boolean",
"description": "True in the case of a domain tenant collecting several tenants, otherwise false."
},
"factories": {
"type": "array",
"description": "A list of resource types supported by the external generator set in `factory`.",
"items": {
"type": "object"
}
},
"factory": {
"type": "string",
"description": "The address of the custom random resource generator (user, team) in [RFC 6570 - URI temaplate](https://tools.ietf.org/html/rfc6570) format.\nThe URI template receives the type of the object to be generated (user, team) in the `kind` parameter, and the identifier of the object to be generated in the `name` parameter."
},
"favicon": {
"type": "string",
"description": "The URL of the tenant favicon. The image from this address appears as a shortcut icon in the browser when a user visits the tenant's webpages."
},
"issuer": {
"type": "string",
"description": "The URL of the tenant OpenID Connect issuer. This value allows you to get, for example, the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nAs a webpage, it contains information on the use if the given tenant."
},
"logo": {
"type": "string",
"description": "The URL of the tenant logo. The image from this address appears in the address bar of the tenant's webpages and the pages that contain the list of available tenants."
},
"name": {
"type": "string",
"description": "The displayed tenant name. In lack of such name, the DNS name of the tenant is displayed in the address bar of the tenant's webpages."
},
"script": {
"type": "string",
"description": "The URL of a custom JavaScript file can be automatically inserted in the login.html, consent.html, és test.html pages."
},
"sheet": {
"type": "string",
"description": "It is used to give the identifyer of a public Google Sheet document. The first line of the table contains the user property names, the following lines, on the other hand, contain the relevant data.\nIn the case of nested properties, a '.' character separates the elements of the property name (e.g. address.formatted)."
},
"sub": {
"type": "string",
"description": "The fully qualified DNS domain name of the tenant. In the case of official and shared tenants (phantauth.net and phantauth.cf DNS domain), the DNS domain can be omitted (e.g. *default* or *faker*)."
},
"subtenant": {
"type": "boolean",
"description": "True in the case of a tenant referred to in a domain tenant, otherwise false."
},
"summary": {
"type": "string",
"description": "A one-line description, the watchword of the tenant. It appears on the tenant's startup page and the pages that contain the list of available tenants. It takes the valua of an unformatted text."
},
"template": {
"type": "string",
"description": "It defines the place of the templates of the HTML pages of the tenant in [RFC 6570 - URI temaplate](https://tools.ietf.org/html/rfc6570) format.\nThe URI template receives the page name in a `resource` parameter. By default, it takes the following value: `https://default.phantauth.net{/resource}`."
},
"theme": {
"type": "string",
"description": "The URL of the CSS style sheet used for the tenant's webpages.\nThe default webpage templates were created by the use of the Bootstrap library, therefore, the Bootstrap CSS URL has to be provided when such a webpage is used."
},
"userinfo": {
"type": "string"
},
"website": {
"type": "string",
"description": "The website address associated with the tenant. If a tenant doesn't have a website, its value is identical with that of the `issuer` property."
}
}
}