Remove mapping schema from the doc
The mapping schema is now super long and complex, and anyone interested in it can go to our code base and read about it, no need to track in the doc. Closes-bug: #1617361 Change-Id: I8a83dd91d0cde7af2a10e02b75659704baad5496
This commit is contained in:
Marek Denis
Dave Chen
parent
050bc963e2
commit
c613dd3a6c
|
|
@ -6,7 +6,6 @@ Keystone's one-stop-shop for all federated identity documentation.
|
|||
|
||||
.. include:: configure_federation.rst
|
||||
.. include:: mapping_combinations.rst
|
||||
.. include:: mapping_schema.rst
|
||||
.. include:: openidc.rst
|
||||
.. include:: mellon.rst
|
||||
.. include:: shibboleth.rst
|
||||
|
|
|
|||
|
|
@ -97,8 +97,7 @@ the argument(s) passed as input and is/are also present in the whitelist.
|
|||
``empty``, ``blacklist`` and ``whitelist`` are the only conditions that can
|
||||
be used in direct mapping ({0}, {1}, etc.)
|
||||
|
||||
You can combine multiple conditions in a single rule. The schema that needs to be
|
||||
followed for the mapping rules can be seen in the :doc:`mapping_schema` page.
|
||||
Multiple conditions can be combined to create a single rule.
|
||||
|
||||
Mappings Examples
|
||||
-----------------
|
||||
|
|
|
|||
|
|
@ -1,161 +0,0 @@
|
|||
..
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
||||
use this file except in compliance with the License. You may obtain a copy
|
||||
of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
Mapping Schema
|
||||
==============
|
||||
|
||||
-----------
|
||||
Description
|
||||
-----------
|
||||
|
||||
The schema for mapping is a description of how a mapping should be created.
|
||||
It shows all the requirements and possibilities for a JSON to be used for mapping.
|
||||
|
||||
Mapping schema is validated with `JSON Schema
|
||||
<http://json-schema.org/documentation.html>`__
|
||||
|
||||
--------------
|
||||
Mapping Schema
|
||||
--------------
|
||||
|
||||
The rules supported must use the following schema:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
{
|
||||
"type": "object",
|
||||
"required": ['rules'],
|
||||
"properties": {
|
||||
"rules": {
|
||||
"minItems": 1,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": ['local', 'remote'],
|
||||
"additionalProperties": False,
|
||||
"properties": {
|
||||
"local": {
|
||||
"type": "array"
|
||||
},
|
||||
"remote": {
|
||||
"minItems": 1,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"oneOf": [
|
||||
{"$ref": "#/definitions/empty"},
|
||||
{"$ref": "#/definitions/any_one_of"},
|
||||
{"$ref": "#/definitions/not_any_of"},
|
||||
{"$ref": "#/definitions/blacklist"},
|
||||
{"$ref": "#/definitions/whitelist"}
|
||||
],
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"empty": {
|
||||
"type": "object",
|
||||
"required": ['type'],
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string"
|
||||
},
|
||||
},
|
||||
"additionalProperties": False,
|
||||
},
|
||||
"any_one_of": {
|
||||
"type": "object",
|
||||
"additionalProperties": False,
|
||||
"required": ['type', 'any_one_of'],
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string"
|
||||
},
|
||||
"any_one_of": {
|
||||
"type": "array"
|
||||
},
|
||||
"regex": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"not_any_of": {
|
||||
"type": "object",
|
||||
"additionalProperties": False,
|
||||
"required": ['type', 'not_any_of'],
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string"
|
||||
},
|
||||
"not_any_of": {
|
||||
"type": "array"
|
||||
},
|
||||
"regex": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"blacklist": {
|
||||
"type": "object",
|
||||
"additionalProperties": False,
|
||||
"required": ['type', 'blacklist'],
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string"
|
||||
},
|
||||
"blacklist": {
|
||||
"type": "array"
|
||||
}
|
||||
}
|
||||
},
|
||||
"whitelist": {
|
||||
"type": "object",
|
||||
"additionalProperties": False,
|
||||
"required": ['type', 'whitelist'],
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string"
|
||||
},
|
||||
"whitelist": {
|
||||
"type": "array"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.. NOTE::
|
||||
|
||||
``"additionalProperties": False``, shows that only the properties shown can be displayed.
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
"whitelist": {
|
||||
"type": "object",
|
||||
"additionalProperties": False,
|
||||
"required": ['type', 'whitelist'],
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string"
|
||||
},
|
||||
"whitelist": {
|
||||
"type": "array"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Keystone will not accept any other keys in the JSON mapping other than ``type``, and
|
||||
``whitelist``.
|
||||
Loading…
Reference in New Issue