Authorization Resource

REF: Authorization.docx: Appendix D; espiDerived.xsd</h4>

Element

Description

Sample Content

authorizedPeriod

Restricts access to requests or subscriptions within this date time interval.

<authorizedPeriod>

            <duration>31536000</duration>

            <start>1333252800</start>

</authorizedPeriod>

publishedPeriod

Restricts access to the objects within the associated resource that were published within this date time interval.

<publishedPeriod>

            <duration>31536000</duration>

            <start>1333252800</start>

</publishedPeriod>

access_token

Contains the access token associated with this authorization. (OAuth contains access_token for RetailCustomer resources obtained through authorization code flow, registration_access_token obtained in the registration process, and an access_token obtained through  client credentials flow)

AA886A7A-078D-4307-A3D9-AA036796DBC3

status

The status of this authorization.

                  0 - Revoked

                  1 - Active

                  2 - Denied

1

expiresAt

Expiration period for the accessToken (seconds) ????

Change to UTC seconds of expires

86400

grant_type

Type of grant being negotiated for.

authorization_code

refresh_token

Used to obtain a fresh access_token.

AA886A7A-078D-4307-A3D9-AA036796DBC4

scope

Negotiated scope of the authorization

FB=1_3_4_5_13_14_15_19_37_39;IntervalDuration=3600;BlockDuration=monthly;HistoryLength=94608000

token_type

type of token used

bearer

error

contains last error returned to ThirdParty

server_error

error_description

contains free text string describing last error returned to ThirdParty

No service

error_uri

specific error URI for last returned error

na

resourceURI

resourceURI that represents the data set authorized. Can be used in a GET of the resource subscription.

http://localhost:8080/DataCustodian/espi/1_1/resource/Batch/Subscription/1

authorizationURI

URI that can be used to update or delete this Authorization

http://localhost:8080/DataCustodian/espi/1_1/resource/Authorization/1

 

</div>