PUT /oauth/admin/grants/{GrantID}/properties

Updates information about the properties for the specified OAuth grant.

Authorization Roles/Permissions: Must be an authorized user for the resource. Authentication cookie is required.

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{oauth-provider-url}/oauth/admin/{GrantID}/properties

Back to top

Sample Request

The example below shows a sample request

Request URL

https://{oauth-provider-url}/oauth/admin/{GrantID}/properties

Sample request headers

Cookie: OAuthToken_{OAuthProviderName}

Sample request body

{
  "GrantProperty":[
    {
      "Name":"OAuthPropertyId",
      "Value":"listDiscussions"
    }
  ]
}

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/xml, application/json
Content-Type application/xml, application/json
OAuthToken_{OAuthProviderName} The OAuth cookie that identifies the logged-in user with the provider. Depending on the operation being used and the context, the authenticated user could be the resource owner, the administrator, the client app administration, or the OAuth Provider. The cookie is returned after logging in with the POST /oauth/login operation.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
GrantID Path string Required The unique ID for a specific instance of an OAuth grant.
GrantProperties Body GrantProperties Required Contains information about OAuth grant properties.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the grant.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/xml, application/json

Back to top

Response Body

Name Type Description
Grant Grant Contains information about an OAuth grant.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the OAuthToken_{OAuthProviderName} cookie, or if you included an invalid cookie.
500 An error occurred processing the call.

More information about Enterprise API Platform API error messages.

Back to top

Related Topics