Token and access Key API

• Index - API Documentation
• Parameters - API Parameter Details
• Profiles - Manage user profiles
• Resources - Manage resources
• Rules - Manage the ACRs for resources
• EML - Manage EML documents and associated ACRs
• Groups - Manage groups and group members
• Search - Search for profiles and groups
• Tokens and access keys - Manage tokens and access keys

---

Refresh Token

POST /auth/v1/token/refresh — refreshToken()

Validate and refresh EDI authentication tokens. A refreshed token matches the original but has a new TTL.

Required permission: A valid edi-token is required.

Parameters

Parameter	In	Required	Description
edi-token	JSON body	Yes	Valid EDI authentication token

Response

Status	Description
200 OK	Tokens refreshed successfully
400 Bad Request	See Parameters
401 Unauthorized	One or both tokens are invalid or expired
403 Forbidden	See Parameters

200 OK response body:

Field	Description
method	"refreshToken"
msg	"EDI token refreshed successfully"
edi-token	Refreshed EDI token

Example

Request:

curl -X POST https://auth.edirepository.org/auth/v1/token/refresh \
  -d '{
    "edi-token": "eyJhbGciOiJFUzI1NiIsInR5cCI6I..."
  }'

Response 200 OK:

{
  "method": "getTokenByKey",
  "msg": "EDI token refreshed successfully",
  "edi-token": "eyJhbGciOiJFUzI1NiIsInR5cCI6I..."
}

---

Get Token by access Key

POST /auth/v1/key — getTokenByKey()

Retrieve an authentication token using an access key.

Required permission: None.

Parameters

Parameter	In	Required	Description
key	JSON body	Yes	access key

Response

Status	Description
200 OK	Token created successfully
400 Bad Request	See Parameters
401 Unauthorized	API key is invalid or expired
403 Forbidden	See Parameters

200 OK response body:

Field	Description
method	"getTokenByKey"
msg	"Token created successfully"
edi-token	The new authentication token

Example

Request:

curl -X POST https://auth.edirepository.org/auth/v1/key \
  -d '{"key": "R9arQwYMFqdgVVYt7jqcsxfyPyU"}'

Response 200 OK:

{
  "method": "getTokenByKey",
  "msg": "Token created successfully",
  "edi-token": "eyJhbGciOiJFUzI1NiIsInR5cCI6I..."
}