Workspaces API

V2 License Access

GET

/workspace/evo/identity/v2/license-access

Verify the user and token has access to the requested resources.

Given a user token, verify that the user has access to the requested service, org and hub, as well as that the token as the required scope.

On success, returns details of the calling user, what they are entitled to, and the authorization the request was made with.

Args: org_id (UUID): UUID of the Evo organisation service (str): service name (i.e. "blockmodel") hub (str): the hub code required_scope(str): scope required for the service Returns: A JSON response.

Request

Query parameters

servicestring[] | null

hubstring | null

org_idstring | null

required_scopestring[] | null

Responses

200

Successful Response

Response schema

auth_detailsLicenseAccessAuthDetails

Auth details,retrieved from token, for v2 License Access Response

client_idstring

expinteger

iatinteger

issstring | null

jtistring | null

scopestring[] | null

sidstring | null

typestring

verstring

entitlementsLicenseAccessEntitlements

Entitlement details for v2 License Access Response

hub_codestring

instance_idstring | null

instance_namestring | null

org_idstring

org_namestring

rolesstring[]

servicesstring[]

userLicenseAccessUser

User details for v2 License Access Response

org_idstring | null

org_namestring | null

substring

Example response

{
  "auth_details": {
    "client_id": "string",
    "exp": 0,
    "iat": 0,
    "iss": "string",
    "jti": "string",
    "scope": [
      "string"
    ],
    "sid": "string",
    "type": "string",
    "ver": "string"
  },
  "entitlements": {
    "hub_code": "string",
    "instance_id": "string",
    "instance_name": "string",
    "org_id": "string",
    "org_name": "string",
    "roles": [
      "string"
    ],
    "services": [
      "string"
    ]
  },
  "user": {
    "org_id": "string",
    "org_name": "string",
    "sub": "string"
  }
}

401

No permission -- see authorization schemes

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

403

Request forbidden -- authorization will not help

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

404

Resource not found or user lacks access

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

405

Specified method is invalid for this resource

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

422

Unprocessable Content

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}