UPDATERESOURCESERVER()`¶

About UpdateResourceServer¶

Updates the name and scopes of a resource server. All other fields are read-only. For more information about resource servers, see Access control with resource servers.

If you don't provide a value for an attribute, it is set to the default value.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Method Signature¶

METHODS /AWS1/IF_CGP~UPDATERESOURCESERVER
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/CGPRESOURCESERVERIDTYPE OPTIONAL
    !IV_NAME TYPE /AWS1/CGPRESRCSERVERNAMETYPE OPTIONAL
    !IT_SCOPES TYPE /AWS1/CL_CGPRESRCSERVERSCOPE00=>TT_RESOURCESERVERSCOPELISTTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpupdresrcserverrsp
  RAISING
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPTOOMANYREQUESTSEX
    /AWS1/CX_CGPCLIENTEXC
    /AWS1/CX_CGPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_userpoolid` `TYPE /AWS1/CGPUSERPOOLIDTYPE` `/AWS1/CGPUSERPOOLIDTYPE`¶

The ID of the user pool that contains the resource server that you want to update.

`iv_identifier` `TYPE /AWS1/CGPRESOURCESERVERIDTYPE` `/AWS1/CGPRESOURCESERVERIDTYPE`¶

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

`iv_name` `TYPE /AWS1/CGPRESRCSERVERNAMETYPE` `/AWS1/CGPRESRCSERVERNAMETYPE`¶

The updated name of the resource server.

Optional arguments:¶

`it_scopes` `TYPE /AWS1/CL_CGPRESRCSERVERSCOPE00=>TT_RESOURCESERVERSCOPELISTTYPE` `TT_RESOURCESERVERSCOPELISTTYPE`¶

An array of updated custom scope names and descriptions that you want to associate with your resource server.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cgpupdresrcserverrsp` `/AWS1/CL_CGPUPDRESRCSERVERRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updateresourceserver(
  it_scopes = VALUE /aws1/cl_cgpresrcserverscope00=>tt_resourceserverscopelisttype(
    (
      new /aws1/cl_cgpresrcserverscope00(
        iv_scopedescription = |string|
        iv_scopename = |string|
      )
    )
  )
  iv_identifier = |string|
  iv_name = |string|
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_resourceservertype = lo_result->get_resourceserver( ).
  IF lo_resourceservertype IS NOT INITIAL.
    lv_userpoolidtype = lo_resourceservertype->get_userpoolid( ).
    lv_resourceserveridentifie = lo_resourceservertype->get_identifier( ).
    lv_resourceservernametype = lo_resourceservertype->get_name( ).
    LOOP AT lo_resourceservertype->get_scopes( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_resourceserverscopename = lo_row_1->get_scopename( ).
        lv_resourceserverscopedesc = lo_row_1->get_scopedescription( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_CGP=>UPDATERESOURCESERVER()¶