Commit Graph

18 Commits

Author SHA1 Message Date
Stephen Finucane 802cc846aa api-ref: Fix indentation
Additional paragraphs of a bullet list should be indented by two spaces
to align with the first paragraph, e.g.

  - A bullet list item

    Additional detail

Rather than:

  - A bullet list item

     Additional detail

The latter results in the additional paragraphs being rendered as block
quotes.

Change-Id: I18cd39e65fd8d43691c940a6e849765755c46c2e
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2024-02-27 13:13:01 +00:00
erus bf67b3c884 Add new attribute to the federation protocol API
Modify the FederationProtocolModel class and add the
remote_id_atributte to the federation_protocol table.
Add the respective migration and tests files. And
also modify the schema to expect a remote_id_attribute
property.

Closes-bug: #1724645

Co-authored-by: Colleen Murphy<colleen@gazlene.net>

Change-Id: I9802c8a5c187bae16de89893ca8639b01cd7cb1b
2019-07-19 10:46:23 -07:00
wangxiyuan a7437cae73 Fix the test for unique IdP
The test that IdP and domain is unique constraint is wrong.
Keystone never support Idp:domain is 1:1.

This patch fixed the error in the test to make sure
Idp:domain is n:1.

Change-Id: I90a0ed677aa9d666a220bd2456dac336378cd3ba
Closes-bug: #1760843
2018-05-09 02:29:10 +00:00
Zuul bf5ef260ea Merge "Add explain of mapping group attribute" 2017-11-29 13:38:35 +00:00
zlyqqq 682dc0566c Add explain of mapping group attribute
As we use federation protocol, assign authorization to ephemeral
users by mapping to groups. Setting this mapping does not add the
ephemeral user to the group and the user is not a member of the group.
Only authorization for the user is same as role assignments to the
group on a project or domain.

This patch add explain about the group mapping

Change-Id: I9faa7d57037af3c2cf6ccfda8d853693fa5eb628
2017-10-09 06:04:48 +00:00
zlyqqq 7fda51dc15 Confusing notes of ephemeral user's domain
If a federated user is ephemeral, the user will become a member of
identity provider's domain. The identity provider and service
provider are different entities, this patch correct the note and
make it more distinct.

Change-Id: I71a8b339e2e8f176761a36a4effe09afcf5388a6
2017-09-05 23:30:35 +08:00
Colleen Murphy d10908caa9 Document required `type` mapping attribute
In order for a federated user to be mapped to a local user that exists
in the identity backend, the user object in the local mapping rule must
have the property "type": "local" set, in addition to having a keystone
domain provided. This was probably not the original intention of the
local user mapping spec[1], but this is how it ended up being
implemented. We could choose to change the behavior of the code, but
it has been around long enough that it is possible that deployments are
depending on this behavior, and moreover making rules explicit rather
than implicit reduces the risk of bugs and mistakes.

This patch updates the api-ref documentation and the standard federation
documentation to include the "type" property when mapping to local
users. In addition, since we now have two keywords called "local" that
mean somewhat different things, we expand the context of some of the
mapping examples so that both the rule name "local" and the value
"local" of the attribute "type" appear in the example, for clarity.

Change-Id: Ib35e57e33903de14f9cac1f919c32dfe923ef884
Closes-bug: #1673157
2017-08-07 18:02:56 +02:00
Ronald De Rose 74af136478 Update docs to require domain_id when registering Identity Providers
An Identity Provider (IdP) should be mapped to a domain. This patch
updates the documentation and creates a release note recommending the
domain_id parameter.

Depends-On: Id18b8b2fe853b97631bc990df8188ed64a6e1275
Partial-Bug: #1642687
Change-Id: I1cb749371175169662dbb5fa8feafe403fb1c39b
2017-01-06 19:09:36 +00:00
Steve Martinelli 46b71ef23b add a header for the federation APIs
Change-Id: I9799c7690a8baf4ab87de3ed12b1e3099ae68e22
2016-08-12 17:12:54 -04:00
Samuel de Medeiros Queiroz 8eb67a9e01 Move Assertion API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Assertion API to its own file is one of the TODO comments left
there, which is being addressed in this change.

Change-Id: I0ad565619744eb7f7b3c2fb33971d8d8ab4e22ea
2016-08-03 01:58:02 +00:00
Samuel de Medeiros Queiroz 62d0175ada Move Federation Auth API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Auth API to its own file is one of the TODO comments left there,
which is being addressed in this change.

Change-Id: Icd0c293c1a326c9bf3fe1ca01c96e3908ac33db3
2016-08-02 13:18:19 -03:00
Samuel de Medeiros Queiroz edd5827199 Move List Projects and Domains API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving List Projects and Domains API to its own file is one of the TODO
comments left there, which is being addressed in this change.

Change-Id: I78572d6605c7eddd9c7b41bb2e982dc10728f46e
2016-08-02 13:07:07 -03:00
Samuel de Medeiros Queiroz 34dd18c2c2 Move Service Provider API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Service Provider API to its own file is one of the TODO
comments left there, which is being addressed in this change.

Change-Id: Iabe3d443f01b173024620aae629558d228c2cd10
2016-08-02 13:04:45 -03:00
Samuel de Medeiros Queiroz fc9cfb76c5 Move Mapping API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Mapping API to its own file is one of the TODO comments left
there, which is being addressed in this change.

Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
2016-08-02 12:52:33 -03:00
Steve Martinelli 85570dc678 refactor idp to its own file
for comparison

Change-Id: Ia1becc2fa36f095e30f306c6436bd180fb8760a2
2016-07-30 20:35:19 -07:00
Samuel de Medeiros Queiroz 0f6fa0e3d3 Move Identity Provider API to its own file
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.

Moving Identity Provider API to its own file is one of the TODO
comments left there, which is being addressed in this change.

Change-Id: I5c5b26c2d4c9920d6b9642eaf0fc47ed5bffb3cb
2016-07-29 15:28:04 -03:00
Clenimar Filemon ab7a7458e1 Improve os-federation docs
- add /v3/ to all routes;
- switch from 'localhost:port' and 'identity:port' endpoints to
  'example.com/identity';
- fix typo.

Change-Id: If0d90ebab78e93fc9395b0e02436853a4ecbfa73
2016-07-25 22:39:23 -03:00
Samuel de Medeiros Queiroz 53b5b99785 Migrate OS-FEDERATION from specs repo
This commit migrates OS-FEDERATION docs from the spec repo to keystone server
repo under api-ref/source/v3-ext/ directory.

Change-Id: I2423030bd0849c051d22f63bf60b6a5f41f72574
2016-07-17 03:27:18 +00:00