rw-project - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwProjectMano_RwProject_t_schema
Global Schema Pointer	rw_ypbc_RwProjectMano_RwProject_g_schema

rw-project data

This yang module defines project-based tenancy for RIFT.ware. Authorization for project access is defined in terms of RIFT.ware's Role-Based Access Control (RBAC) model.

rw-project:project

Configuration and state for individual projects. RIFT.ware applications and projects are expected to augment this list in order to add configuration for projects that is specific to the product or application. As such, this list contains minimal data defined in this yang module. When augmenting this element, other yang modules should prefer to define containers with the same name as the augmenting module. (Augmenting RIFT.ware modules should prefer to augment without the rw prefix [for new features], or should prefer to augment the augmented container of an existing augment, to ease future adoption and/or standardization.)

Key Identifiers:

XPath Path	/rw-project:project
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']
RW.REST URI Path	/rw-project:project/STRING

Fields

Name	Type	Description
name	STRING	Name of the project.
description	STRING	Information about project
project-config	CONTAINER	General Project configuration supported by all products.
project-state	CONTAINER	General Project operational state supported by all products.

JSON Config Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "project-config": {
      "user": [ { ... }, { ... } ]
    }
  }, {
    ...
  }
]

JSON Sample

[
  {
    "name": "STRING",
    "description": "STRING",
    "project-config": {
      "user": [ { ... }, { ... } ]
    },
    "project-state": {
      "user": [ { ... }, { ... } ],
      "role": [ { ... }, { ... } ],
      "rw-project-mano:mano-role": [ { ... }, { ... } ]
    }
  }, {
    ...
  }
]

XML Config Sample

<rw-project:project xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:name>STRING</rw-project:name>
  <rw-project:description>STRING</rw-project:description>
  <rw-project:project-config>
    <rw-project:user>...</rw-project:user>
  </rw-project:project-config>
</rw-project:project>

XML Sample

<rw-project:project xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:name>STRING</rw-project:name>
  <rw-project:description>STRING</rw-project:description>
  <rw-project:project-config>
    <rw-project:user>...</rw-project:user>
  </rw-project:project-config>
  <rw-project:project-state>
    <rw-project:user>...</rw-project:user>
    <rw-project:role>...</rw-project:role>
    <rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">...</rw-project-mano:mano-role>
  </rw-project:project-state>
</rw-project:project>

rw-project:project-config

General Project configuration supported by all products.

Key Identifiers:

XPath Path	/rw-project:project/rw-project:project-config
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rw-project:project-config
RW.REST URI Path	/rw-project:project/STRING/project-config

Fields

Name	Type	Description
user	LIST	The list of Users who have been assigned Roles within this Project.

JSON Config Sample

{
  "user": [
    {
      "user-domain": "STRING",
      "user-name": "STRING",
      "role": [ { ... }, { ... } ],
      "rw-project-mano:mano-role": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

JSON Sample

{
  "user": [
    {
      "user-domain": "STRING",
      "user-name": "STRING",
      "role": [ { ... }, { ... } ],
      "rw-project-mano:mano-role": [ { ... }, { ... } ]
    }, {
      ...
    }
  ]
}

XML Config Sample

<rw-project:project-config xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user>
    <rw-project:user-name>STRING</rw-project:user-name>
    <rw-project:user-domain>STRING</rw-project:user-domain>
    <rw-project:role>...</rw-project:role>
    <rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">...</rw-project-mano:mano-role>
  </rw-project:user>
</rw-project:project-config>

XML Sample

<rw-project:project-config xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user>
    <rw-project:user-name>STRING</rw-project:user-name>
    <rw-project:user-domain>STRING</rw-project:user-domain>
    <rw-project:role>...</rw-project:role>
    <rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">...</rw-project-mano:mano-role>
  </rw-project:user>
</rw-project:project-config>

rw-project:user

The list of Users who have been assigned Roles within this Project.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-config/rw-project:user

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-config/user/STRING,STRING

Fields

Name	Type	Description
user-domain	LEAFREF	The user domain. This is the source of the user identity. Different domains may duplicate a user-name, but such users would be considered distinct by RIFT.ware.
user-name	LEAFREF	The user name. The syntax of this name depends on the domain. For example, if the domain is a login name, it might be limited to alphanumeric characters. However, if the domain is email address, the syntax could include additional characters, such as the at(@) sign.
role	LIST	The list of Roles the User has been assigned.
mano-role	LIST	The list of MANO application-specific Roles the User has been assigned, within the enclosing Project.

JSON Config Sample

[
  {
    "user-domain": "STRING",
    "user-name": "STRING",
    "role": [
      {
        "role": "STRING"
      }, {
        ...
      }
    ],
    "rw-project-mano:mano-role": [
      {
        "role": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

JSON Sample

[
  {
    "user-domain": "STRING",
    "user-name": "STRING",
    "role": [
      {
        "role": "STRING"
      }, {
        ...
      }
    ],
    "rw-project-mano:mano-role": [
      {
        "role": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Config Sample

<rw-project:user xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user-name>STRING</rw-project:user-name>
  <rw-project:user-domain>STRING</rw-project:user-domain>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
  </rw-project:role>
  <rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
    <rw-project-mano:role>STRING</rw-project-mano:role>
  </rw-project-mano:mano-role>
</rw-project:user>

XML Sample

<rw-project:user xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user-name>STRING</rw-project:user-name>
  <rw-project:user-domain>STRING</rw-project:user-domain>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
  </rw-project:role>
  <rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
    <rw-project-mano:role>STRING</rw-project-mano:role>
  </rw-project-mano:mano-role>
</rw-project:user>

rw-project:role

The list of Roles the User has been assigned.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-config/rw-project:user/rw-project:role

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-config/user/STRING,STRING/role/STRING

Fields

Name	Type	Description
role	STRING	The Role, independent of Keys.

JSON Config Sample

[
  {
    "role": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "role": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
</rw-project:role>

XML Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
</rw-project:role>

rw-project-mano:mano-role

The list of MANO application-specific Roles the User has been assigned, within the enclosing Project.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-config/rw-project:user/rw-project-mano:mano-role

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-config/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project-mano:mano-role[rw-project-mano:role='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-config/user/STRING,STRING/rw-project-mano:mano-role/STRING

Fields

Name	Type	Description
role	STRING	The Role, independent of Keys.

JSON Config Sample

[
  {
    "role": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "role": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
  <rw-project-mano:role>STRING</rw-project-mano:role>
</rw-project-mano:mano-role>

XML Sample

<rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
  <rw-project-mano:role>STRING</rw-project-mano:role>
</rw-project-mano:mano-role>

rw-project:project-state

General Project operational state supported by all products.

Key Identifiers:

XPath Path	/rw-project:project/rw-project:project-state
XPath Keyed Path	/rw-project:project[rw-project:name='STRING']/rw-project:project-state
RW.REST URI Path	/rw-project:project/STRING/project-state

Fields

Name	Type	Description
user	LIST	The state of Users who have been assigned Roles within this Project.
role	LIST	The set of Roles that may be configured into /rw-project:project/rw-project:config/rw-project:user/ rw-project:role.
mano-role	LIST	The set of Roles that may be configured into /rw-project:project/rw-project:project-config/rw-project:user/ rw-project-mano:mano-role/rw-project-mano:role.

JSON Sample

{
  "user": [
    {
      "user-domain": "STRING",
      "user-name": "STRING",
      "role": [ { ... }, { ... } ],
      "rw-project-mano:mano-role": [ { ... }, { ... } ]
    }, {
      ...
    }
  ],
  "role": [
    {
      "role": "STRING",
      "description": "STRING"
    }, {
      ...
    }
  ],
  "rw-project-mano:mano-role": [
    {
      "role": "STRING",
      "description": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<rw-project:project-state xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user>
    <rw-project:user-name>STRING</rw-project:user-name>
    <rw-project:user-domain>STRING</rw-project:user-domain>
    <rw-project:role>...</rw-project:role>
    <rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">...</rw-project-mano:mano-role>
  </rw-project:user>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
    <rw-project:description>STRING</rw-project:description>
  </rw-project:role>
  <rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
    <rw-project-mano:role>STRING</rw-project-mano:role>
    <rw-project-mano:description>STRING</rw-project-mano:description>
  </rw-project-mano:mano-role>
</rw-project:project-state>

rw-project:user

The state of Users who have been assigned Roles within this Project.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-state/rw-project:user

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-state/user/STRING,STRING

Fields

Name	Type	Description
user-domain	STRING	The user domain. This is the source of the user identity. Different domains may duplicate a user-name, but such users would be considered distinct by RIFT.ware.
user-name	STRING	The user name. The syntax of this name depends on the domain. For example, if the domain is a login name, it might be limited to alphanumeric characters. However, if the domain is some kind of email address, the syntax could include assitional characters, such as the at sign.
role	LIST	The state of the Roles the User has been assigned.
mano-role	LIST	The state of the MANO application-specific Role the User has been assigned.

JSON Sample

[
  {
    "user-domain": "STRING",
    "user-name": "STRING",
    "role": [
      {
        "role": "STRING",
        "state": "STRING"
      }, {
        ...
      }
    ],
    "rw-project-mano:mano-role": [
      {
        "role": "STRING",
        "state": "STRING"
      }, {
        ...
      }
    ]
  }, {
    ...
  }
]

XML Sample

<rw-project:user xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:user-name>STRING</rw-project:user-name>
  <rw-project:user-domain>STRING</rw-project:user-domain>
  <rw-project:role>
    <rw-project:role>STRING</rw-project:role>
    <rw-project:state>STRING</rw-project:state>
  </rw-project:role>
  <rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
    <rw-project-mano:role>STRING</rw-project-mano:role>
    <rw-project-mano:state>STRING</rw-project-mano:state>
  </rw-project-mano:mano-role>
</rw-project:user>

rw-project:role

The state of the Roles the User has been assigned.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-state/rw-project:user/rw-project:role

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project:role[rw-project:role='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-state/user/STRING,STRING/role/STRING

Fields

Name	Type	Description
role	STRING	The Role, independent of Keys.
state	STRING	The assignment of a User to a Role may be an asynchronous operation. This value indicates whether the Role assignment is active. If the value is 'active', then the assignment is complete and active. Any other value indicates that Role assignment is in a transitional or failed state, as described in the value.

JSON Sample

[
  {
    "role": "STRING",
    "state": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
  <rw-project:state>STRING</rw-project:state>
</rw-project:role>

rw-project-mano:mano-role

The state of the MANO application-specific Role the User has been assigned.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-state/rw-project:user/rw-project-mano:mano-role

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:user[rw-project:user-name='STRING'][rw-project:user-domain='STRING']/rw-project-mano:mano-role[rw-project-mano:role='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-state/user/STRING,STRING/rw-project-mano:mano-role/STRING

Fields

Name	Type	Description
role	STRING	The Role, independent of Keys.
state	STRING	The assignment of a User to a Role may be an asynchronous operation. This value indicates whether the Role assignment is active. If the value is 'active', then the assignment is complete and active. Any other value indicates that Role assignment is in a transitional or failed state, as described in the value.

JSON Config Sample

[
  {
    "role": "STRING",
    "state": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "role": "STRING",
    "state": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
  <rw-project-mano:role>STRING</rw-project-mano:role>
  <rw-project-mano:state>STRING</rw-project-mano:state>
</rw-project-mano:mano-role>

XML Sample

<rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
  <rw-project-mano:role>STRING</rw-project-mano:role>
  <rw-project-mano:state>STRING</rw-project-mano:state>
</rw-project-mano:mano-role>

rw-project:role

The set of Roles that may be configured into /rw-project:project/rw-project:config/rw-project:user/ rw-project:role.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-state/rw-project:role

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project:role[rw-project:role='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-state/role/STRING

Fields

Name	Type	Description
role	STRING	The Role, independent of Keys.
description	STRING	A description of the Role.

JSON Sample

[
  {
    "role": "STRING",
    "description": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-project:role xmlns:rw-project="http://riftio.com/ns/riftware-1.0/rw-project">
  <rw-project:role>STRING</rw-project:role>
  <rw-project:description>STRING</rw-project:description>
</rw-project:role>

rw-project-mano:mano-role

The set of Roles that may be configured into /rw-project:project/rw-project:project-config/rw-project:user/ rw-project-mano:mano-role/rw-project-mano:role.

Key Identifiers:

XPath Path

/rw-project:project/rw-project:project-state/rw-project-mano:mano-role

XPath Keyed Path

/rw-project:project[rw-project:name='STRING']/rw-project:project-state/rw-project-mano:mano-role[rw-project-mano:role='STRING']

RW.REST URI Path

/rw-project:project/STRING/project-state/rw-project-mano:mano-role/STRING

Fields

Name	Type	Description
role	STRING	The Role, independent of Keys.
description	STRING	A description of the Role.

JSON Config Sample

[
  {
    "role": "STRING",
    "description": "STRING"
  }, {
    ...
  }
]

JSON Sample

[
  {
    "role": "STRING",
    "description": "STRING"
  }, {
    ...
  }
]

XML Config Sample

<rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
  <rw-project-mano:role>STRING</rw-project-mano:role>
  <rw-project-mano:description>STRING</rw-project-mano:description>
</rw-project-mano:mano-role>

XML Sample

<rw-project-mano:mano-role xmlns:rw-project-mano="http://riftio.com/ns/riftware-1.0/rw-project-mano">
  <rw-project-mano:role>STRING</rw-project-mano:role>
  <rw-project-mano:description>STRING</rw-project-mano:description>
</rw-project-mano:mano-role>

rw-project-mano - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwProjectMano_RwProjectMano_t_schema
Global Schema Pointer	rw_ypbc_RwProjectMano_RwProjectMano_g_schema