"Fossies" - the Fresh Open Source Software Archive

Member "keystone-17.0.0/api-ref/source/v3-ext/federation/identity-provider/idp.inc" (13 May 2020, 9425 Bytes) of package /linux/misc/openstack/keystone-17.0.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) fasm source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. For more information about "idp.inc" see the Fossies "Dox" file reference documentation and the latest Fossies "Diffs" side-by-side code changes report: 16.0.1_vs_17.0.0.

    1 .. -*- rst -*-
    2 
    3 Register an identity provider
    4 =============================
    5 
    6 .. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{id}
    7 
    8 Register an identity provider to be used to authenticate federated users.
    9 
   10 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
   11 
   12 Request
   13 -------
   14 
   15 Parameters
   16 ~~~~~~~~~~
   17 .. rest_parameters:: federation/identity-provider/parameters.yaml
   18 
   19     - authorization_ttl: authorization_ttl
   20     - domain_id: domain_id
   21     - description: description
   22     - enabled: enabled
   23     - id: id_path
   24     - remote_ids: remote_ids
   25 
   26 As a domain may only be associated to a single identity provider, a 409 response code will be
   27 returned if the specified ``domain_id`` already maps an existing identity provider.
   28 
   29 Example
   30 ~~~~~~~
   31 
   32 .. literalinclude:: federation/identity-provider/samples/register-request.json
   33    :language: javascript
   34 
   35 Response
   36 --------
   37 
   38 Parameters
   39 ~~~~~~~~~~
   40 
   41 .. rest_parameters:: federation/identity-provider/parameters.yaml
   42 
   43     - authorization_ttl: authorization_ttl
   44     - domain_id: domain_id
   45     - description: description
   46     - enabled: enabled
   47     - id: id_body
   48     - links: links
   49     - remote_ids: remote_ids
   50 
   51 Status Codes
   52 ~~~~~~~~~~~~
   53 
   54 .. rest_status_code:: success ../v3/status.yaml
   55 
   56    - 201
   57 
   58 Example
   59 ~~~~~~~
   60 
   61 .. literalinclude:: federation/identity-provider/samples/register-response.json
   62    :language: javascript
   63 
   64 
   65 List identity providers
   66 =======================
   67 
   68 .. rest_method::  GET /v3/OS-FEDERATION/identity_providers
   69 
   70 List registered identity providers.
   71 
   72 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_providers``
   73 
   74 Request
   75 -------
   76 
   77 Parameters
   78 ~~~~~~~~~~
   79 
   80 .. rest_parameters:: federation/identity-provider/parameters.yaml
   81 
   82     - id: id_query
   83     - enabled: enabled_query
   84 
   85 Response
   86 --------
   87 
   88 Parameters
   89 ~~~~~~~~~~
   90 
   91 .. rest_parameters:: federation/identity-provider/parameters.yaml
   92 
   93     - identity_providers: identity_providers
   94 
   95 Status Codes
   96 ~~~~~~~~~~~~
   97 
   98 .. rest_status_code:: success ../v3/status.yaml
   99 
  100    - 200
  101 
  102 Example
  103 ~~~~~~~~
  104 
  105 .. literalinclude:: federation/identity-provider/samples/list-response.json
  106    :language: javascript
  107 
  108 
  109 Get identity provider
  110 =====================
  111 
  112 .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}
  113 
  114 Get registered identity providers.
  115 
  116 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
  117 
  118 Request
  119 -------
  120 
  121 Parameters
  122 ~~~~~~~~~~
  123 
  124 .. rest_parameters:: federation/identity-provider/parameters.yaml
  125 
  126     - id: id_path
  127 
  128 Response
  129 --------
  130 
  131 Parameters
  132 ~~~~~~~~~~
  133 
  134 .. rest_parameters:: federation/identity-provider/parameters.yaml
  135 
  136     - authorization_ttl: authorization_ttl
  137     - domain_id: domain_id
  138     - description: description
  139     - enabled: enabled
  140     - id: id_body
  141     - links: links
  142     - remote_ids: remote_ids
  143 
  144 Status Codes
  145 ~~~~~~~~~~~~
  146 
  147 .. rest_status_code:: success ../v3/status.yaml
  148 
  149    - 200
  150 
  151 Example
  152 ~~~~~~~
  153 
  154 .. literalinclude:: federation/identity-provider/samples/get-response.json
  155    :language: javascript
  156 
  157 
  158 Delete identity provider
  159 ========================
  160 
  161 .. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{id}
  162 
  163 When an identity provider is deleted, any tokens generated by that identity
  164 provider will be revoked.
  165 
  166 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
  167 
  168 Request
  169 -------
  170 
  171 Parameters
  172 ~~~~~~~~~~
  173 
  174 .. rest_parameters:: federation/identity-provider/parameters.yaml
  175 
  176     - id: id_path
  177 
  178 Response
  179 --------
  180 
  181 Status Codes
  182 ~~~~~~~~~~~~
  183 
  184 .. rest_status_code:: success ../v3/status.yaml
  185 
  186    - 204
  187 
  188 Update identity provider
  189 ========================
  190 
  191 .. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{id}
  192 
  193 When an identity provider is disabled, any tokens generated by that identity
  194 provider will be revoked.
  195 
  196 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider``
  197 
  198 Request
  199 -------
  200 
  201 Except ``domain_id``, any attribute of an Identity Provider may be passed in
  202 the request body. To update the ``domain_id``, you will need to delete and
  203 recreate the Identity Provider. If ``domain_id`` is included in the request, a
  204 400 response code will be returned.
  205 
  206 Parameters
  207 ~~~~~~~~~~
  208 
  209 .. rest_parameters:: federation/identity-provider/parameters.yaml
  210 
  211     - id: id_path
  212 
  213 Example
  214 ~~~~~~~
  215 
  216 .. literalinclude:: federation/identity-provider/samples/update-request.json
  217    :language: javascript
  218 
  219 Response
  220 --------
  221 
  222 Parameters
  223 ~~~~~~~~~~
  224 
  225 .. rest_parameters:: federation/identity-provider/parameters.yaml
  226 
  227     - authorization_ttl: authorization_ttl
  228     - domain_id: domain_id
  229     - description: description
  230     - enabled: enabled
  231     - id: id_body
  232     - links: links
  233     - remote_ids: remote_ids
  234 
  235 Status Codes
  236 ~~~~~~~~~~~~
  237 
  238 .. rest_status_code:: success ../v3/status.yaml
  239 
  240    - 200
  241 
  242 Example
  243 ~~~~~~~
  244 
  245 .. literalinclude:: federation/identity-provider/samples/update-response.json
  246    :language: javascript
  247 
  248 
  249 Add protocol to identity provider
  250 =================================
  251 
  252 .. rest_method::  PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
  253 
  254 Add a protocol and attribute mapping to an identity provider.
  255 
  256 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
  257 
  258 Request
  259 -------
  260 
  261 Parameters
  262 ~~~~~~~~~~
  263 
  264 .. rest_parameters:: federation/identity-provider/parameters.yaml
  265 
  266     - idp_id: id_path
  267     - protocol_id: protocol_id
  268     - protocol: protocol
  269 
  270 Example
  271 ~~~~~~~
  272 
  273 .. literalinclude:: federation/identity-provider/samples/add-protocol-request.json
  274    :language: javascript
  275 
  276 Response
  277 --------
  278 
  279 Parameters
  280 ~~~~~~~~~~
  281 
  282 .. rest_parameters:: federation/identity-provider/parameters.yaml
  283 
  284     - protocol: protocol
  285 
  286 Status Codes
  287 ~~~~~~~~~~~~
  288 
  289 .. rest_status_code:: success ../v3/status.yaml
  290 
  291    - 201
  292 
  293 Example
  294 ~~~~~~~
  295 
  296 .. literalinclude:: federation/identity-provider/samples/add-protocol-response.json
  297    :language: javascript
  298 
  299 
  300 List protocols of identity provider
  301 ===================================
  302 
  303 .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{id}/protocols
  304 
  305 List all protocol and attribute mappings of an identity provider.
  306 
  307 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocols``
  308 
  309 Request
  310 -------
  311 
  312 Parameters
  313 ~~~~~~~~~~
  314 
  315 .. rest_parameters:: federation/identity-provider/parameters.yaml
  316 
  317     - id: id_path
  318 
  319 Response
  320 --------
  321 
  322 Parameters
  323 ~~~~~~~~~~
  324 
  325 .. rest_parameters:: federation/identity-provider/parameters.yaml
  326 
  327     - protocols: protocols
  328     - links: protocols_links
  329 
  330 Status Codes
  331 ~~~~~~~~~~~~
  332 
  333 .. rest_status_code:: success ../v3/status.yaml
  334 
  335    - 200
  336 
  337 Example
  338 ~~~~~~~
  339 
  340 .. literalinclude:: federation/identity-provider/samples/list-protocol-response.json
  341    :language: javascript
  342 
  343 
  344 Get protocol for identity provider
  345 ==================================
  346 
  347 .. rest_method::  GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
  348 
  349 Get a protocol and attribute mapping for an identity provider.
  350 
  351 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
  352 
  353 Request
  354 -------
  355 
  356 Parameters
  357 ~~~~~~~~~~
  358 
  359 .. rest_parameters:: federation/identity-provider/parameters.yaml
  360 
  361     - idp_id: id_path
  362     - protocol_id: protocol_id
  363 
  364 Response
  365 --------
  366 
  367 Parameters
  368 ~~~~~~~~~~
  369 
  370 .. rest_parameters:: federation/identity-provider/parameters.yaml
  371 
  372     - protocol: protocol
  373 
  374 Status Codes
  375 ~~~~~~~~~~~~
  376 
  377 .. rest_status_code:: success ../v3/status.yaml
  378 
  379    - 200
  380 
  381 Example
  382 ~~~~~~~
  383 
  384 .. literalinclude:: federation/identity-provider/samples/get-protocol-response.json
  385    :language: javascript
  386 
  387 
  388 Update attribute mapping for identity provider
  389 ==============================================
  390 
  391 .. rest_method::  PATCH /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
  392 
  393 Update the attribute mapping for an identity provider and protocol.
  394 
  395 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
  396 
  397 Request
  398 -------
  399 
  400 Parameters
  401 ~~~~~~~~~~
  402 
  403 .. rest_parameters:: federation/identity-provider/parameters.yaml
  404 
  405     - idp_id: id_path
  406     - protocol_id: protocol_id
  407     - protocol: protocol
  408 
  409 Example
  410 ~~~~~~~
  411 
  412 .. literalinclude:: federation/identity-provider/samples/update-protocol-request.json
  413    :language: javascript
  414 
  415 Response
  416 --------
  417 
  418 Parameters
  419 ~~~~~~~~~~
  420 
  421 .. rest_parameters:: federation/identity-provider/parameters.yaml
  422 
  423     - protocol: protocol
  424 
  425 Status Codes
  426 ~~~~~~~~~~~~
  427 
  428 .. rest_status_code:: success ../v3/status.yaml
  429 
  430    - 200
  431 
  432 Example
  433 ~~~~~~~
  434 
  435 .. literalinclude:: federation/identity-provider/samples/update-protocol-response.json
  436    :language: javascript
  437 
  438 
  439 Delete a protocol from identity provider
  440 ========================================
  441 
  442 .. rest_method::  DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
  443 
  444 Delete a protocol and attribute mapping from an identity provider.
  445 
  446 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/ext/OS-FEDERATION/1.0/rel/identity_provider_protocol``
  447 
  448 Request
  449 -------
  450 
  451 Parameters
  452 ~~~~~~~~~~
  453 
  454 .. rest_parameters:: federation/identity-provider/parameters.yaml
  455 
  456     - idp_id: id_path
  457     - protocol_id: protocol_id
  458 
  459 Response
  460 --------
  461 
  462 Status Codes
  463 ~~~~~~~~~~~~
  464 
  465 .. rest_status_code:: success ../v3/status.yaml
  466 
  467    - 204