Skip to content

Commit

Permalink
Slight documentation changes
Browse files Browse the repository at this point in the history
Make documentation wording adjustments in accordance to code changes of PR #57

Signed-off-by: Elijah Swift <elijah.swift@ibm.com>
  • Loading branch information
ElijahSwiftIBM committed Dec 26, 2023
1 parent 26053bc commit fa81809
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 23 deletions.
4 changes: 2 additions & 2 deletions common/downstream_fatal_error.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pyRACF expects IRRSMO00 to return a non-empty response string after processing a

&nbsp;

A common cause of this error is that the user does not have the proper RACF authorizations as outlined in [our dependencies note](../../index). One of the possible failures is the user not having `READ` authority to the `IRR.IRRSMO00.PRECHECK` resource in the `XFACILIT` class, which is required for `set` or `alter` operations. If you are not certain if you have this authority or if this has been established in your environment, please consult our [Check for & set up RACF Authorizations](../setup_precheck) documentation. Another possibility is the user not having `ALTER` authority to the `userid.IRRSMO00` resource in the `SURROGAT` class, which is required to run pyRACF commands as another userid. Please review our [run as userid](../run_as_userid) documentation for more information on this feature.
A common cause of this error is that the user does not have the proper RACF authorizations as outlined in [our dependencies note](../../index). One of the possible failures is the user not having at least `READ` authority to the `IRR.IRRSMO00.PRECHECK` resource in the `XFACILIT` class, which is required for `set` or `alter` operations. If you are not certain if you have this authority or if this has been established in your environment, please consult our [Check for & set up RACF Authorizations](../setup_precheck) documentation. Another possibility is the user not having `ALTER` authority to the `userid.IRRSMO00` resource in the `SURROGAT` class, which is required to make security requests as another userid. Please review our [run as userid](../run_as_userid) documentation for more information on this feature.

###### Python Script
```python
Expand Down Expand Up @@ -77,7 +77,7 @@ For the `run_as_userid` feature, you must have at least UPDATE access to `ESWIFT

&nbsp;

As stated, this error can also appear if there is a problem with the data pyRACF passes to IRRSMO00. In this situation, you can review the `request_xml` and the `result_dictionary`, which are stored as attributes in the `DownstreamFatalError` exception object for more information.
As stated, may also be raised if there is a problem with the data pyRACF passes to IRRSMO00. In this situation, you can review `DownstreamFatalError.request_xml` and the `DownwstreamFatalError.result_dictionary` for more information.

###### Python Script
```python
Expand Down
19 changes: 5 additions & 14 deletions common/run_as_userid.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ parent: Common

# Run as Userid

Run pyRACF commands as another user.
Make security requests as another user.
{: .fs-6 .fw-300 }

&nbsp;
Expand Down Expand Up @@ -45,18 +45,11 @@ def set_running_userid(

#### 📄 Description

&nbsp;

{: .experimental }
> _This functionality is **Experimental** and is subject to major changes and even being removed entirely._
&nbsp;

Set the **z/OS userid** this "Admin" object will use to run pyRACF commands.
Set the **z/OS userid** who's authority this "Admin" object will use to make security requests.

#### 📥 Parameters
* `new_userid`<br>
The **z/OS userid** this "Admin" object will use to run pyRACF commands. If you pass in `None`, this will clear any userid previously set for this "Admin" object.
The **z/OS userid** who's authority this "Admin" object will use to make security requests. If you pass in `None`, this will clear any userid previously set for this "Admin" object.

#### ❌ Raises
* `UserIdError`<br>
Expand Down Expand Up @@ -91,9 +84,7 @@ def get_running_userid(self) -> None:

#### 📄 Description

&nbsp;

Obtain the **z/OS userid** this "Admin" object will use to run pyRACF commands.
Obtain the **z/OS userid** who's authority this "Admin" object is using to make security requests.

#### 💻 Example

Expand All @@ -102,5 +93,5 @@ Obtain the **z/OS userid** this "Admin" object will use to run pyRACF commands.
>>> from pyracf import UserAdmin
>>> user_admin = UserAdmin(run_as_userid="squidwrd")
>>> user_admin.get_running_userid()
SQUIDWRD
squidwrd
```
10 changes: 6 additions & 4 deletions common/security_request_error.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,20 @@ Understanding the `SecurityRequestError` exception.

&nbsp;

{: .note}
> _For an understanding of IRRSMO00 return and reason codes, see the [IRRSMO00 Return and Reason Codes](https://www.ibm.com/docs/en/zos/3.2.0?topic=operations-return-reason-codes) documentation._
&nbsp;

{: .warning }
> _A **Return Code** of anything other than `0` from IRRSMO00 is indicative of a failure with one or more of the operations performed by IRRSMO00, and pyracf will always raise a `SecurityRequestError` to bring attention to these failures._
> _A **Return Code** of anything other than `0` from IRRSMO00 is indicative of a failure with one or more of the operations performed by IRRSMO00, and pyRACF will always raise a `SecurityRequestError` to bring attention to these failures._
&nbsp;

When the **Return Code** of a **Security Result** returned by IRRSMO00 is **NOT** equal to `0`, a `SecurityRequestError` will be raised to indicate that the request failed. A `SecurityRequestError` can be handled as follows.

&nbsp;

{: .note}
> _For an understanding of IRRSMO00 return and reason codes, see the [IRRSMO00 Return and Reason Codes](https://www.ibm.com/docs/en/zos/3.2.0?topic=operations-return-reason-codes) documentation._
###### Python Script
```python
from pyracf import UserAdmin
Expand Down
9 changes: 7 additions & 2 deletions common/setup_precheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,16 @@ How to set up and check IRRSMO00 precheck configuration.

&nbsp;

In order to use `set` or `alter` functions in pyRACF, users must have `READ` authority to the `IRR.IRRSMO00.PRECHECK` resource as outlined in [our dependencies note](../../index).
{: .note}
> _Changes made using this script may require a SETROPTS REFRESH of the `FACILITY` class._
&nbsp;

A function called `setup_precheck` is included with pyRACF to help streamline this process. You can use this function to verify your level of access, or define the `IRR.IRRSMO00.PRECHECK` profile with no universal access.`
In order to use `set` or `alter` functions in pyRACF, users must have at least `READ` authority to the `IRR.IRRSMO00.PRECHECK` resource as outlined in [our dependencies note](../../index).

&nbsp;

A function called `setup_precheck` is included with pyRACF to help streamline this process. You can use this function to verify your level of access, or define the `IRR.IRRSMO00.PRECHECK` profile with no universal access.

## Example

Expand Down
2 changes: 1 addition & 1 deletion common/userid_error.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Understanding the `UserIdError` exception.

&nbsp;

When the **Running Userid** is being set through an "Admin" object constructor or the `set_running_userid()` function on an `"Admin"` object, a `UserIdError` will be raised if the specified **z/OS userid** is not a string between 1 to 8 characters in length. A `UserIdError` can be handled as follows.
When the **Running Userid** is being set through an "Admin" object constructor or the `set_running_userid()` function on an "Admin" object, a `UserIdError` will be raised if the specified **z/OS userid** is not a string between 1 to 8 characters in length. A `UserIdError` can be handled as follows.

###### Python Script
```python
Expand Down

0 comments on commit fa81809

Please sign in to comment.