access_level.proto
Package : devportal.solo.io
access_level.proto
Table of Contents
AccessLevel
An AccessLevel defines the set of Portals and APIProducts accessible by Users or Groups. Users with access to a Portal will be able to log in, browse portal pages, and view APIProducts. Users with access to an APIProducts will be able to interact with that APIProduct (e.g. view their specification, requests API Keys) if it is published in the accessed Portal.
AccessLevel can be defined at the User level as well as the Group level.
| Field | Type | Label | Description |
|---|---|---|---|
| portals | []common.devportal.solo.io.ObjectRef | repeated | Users and Groups with this access level have access to these Portal objects. |
| apiProducts | []AccessLevel.APIProductPlansAccess | repeated | Users and Groups with this access level have access to these APIProducts. When using a Portal web application, this attribute determines the subset of APIProducts that the user will see (out of all the APIProducts published in that Portal). |
AccessLevel.APIProductPlansAccess
Models access to an APIProduct across the Environments it is included in.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | The name of the APIProduct. | |
| namespace | string | The namespace of the APIProduct. | |
| environments | []AccessLevel.EnvironmentAccess | repeated | The Environments in which the specified APIProducts can be accessed. Omitting this field means the APIProduct cannot be accessed in any Environment. |
AccessLevel.EnvironmentAccess
Identifies an Environment for access.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | The name of the Environment. | |
| namespace | string | The namespace of the Environment. | |
| plans | []string | repeated | The names of the Usage Plans which this User is authorized to utilize when accessing the APIProduct in this Environment. This may be omitted if the Environment does not define a usage plan for the APIProduct. |